Social-Gadget.xml

[Lane, 2009-11-19 02:23:23]

I've made a lot of progress on the Social-Gadget.xml doc and I'd like to check
it in before the break next week.  

To review, start by reading my list of changes below.  Then check out the
preview at http://www.opensocial.org/Technical-Resources/draft/Social-Gadget.xml

Thanks,
Lane

http://codereview.appspot.com/157078/diff/1/2
File OpenSocial-Data-Pipelining.xml (left):

http://codereview.appspot.com/157078/diff/1/2#oldcode233
OpenSocial-Data-Pipelining.xml:233: <section title="Tag:
&lt;os:PeopleRequest&gt;"
moved PeopleRequest, ViewerRequest, OwnerRequest, and ActivitiesRequest to
Social-Gadget.xml

http://codereview.appspot.com/157078/diff/1/4
File OpenSocial-Markup-Language-Tags.xml (left):

http://codereview.appspot.com/157078/diff/1/4#oldcode37
OpenSocial-Markup-Language-Tags.xml:37: <section title="Overview">
Moved all the content to Social-Gadget.xml.  We can delete this file.

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (left):

http://codereview.appspot.com/157078/diff/1/3#oldcode44
Social-Gadget.xml:44: <section title="Using the API Reference">
Moved Using the API reference to the Core-Gadget spec.

http://codereview.appspot.com/157078/diff/1/3#oldcode86
Social-Gadget.xml:86: <section title="Summary">
Moved osapi examples to be near the methods they are examplifying (not a word,
but should be).

http://codereview.appspot.com/157078/diff/1/3#oldcode505
Social-Gadget.xml:505: auth: {"default" : null, "type" : "AuthToken"},
took auth and appId parameters out of the example, since you can't set them from
the client side calls.

http://codereview.appspot.com/157078/diff/1/3#oldcode777
Social-Gadget.xml:777: <section title="osapi.http"
moved osapi.http to Core-Gadget since it's not social

http://codereview.appspot.com/157078/diff/1/3#oldcode1778
Social-Gadget.xml:1778: <section title="Constructor"
removed docs for constructors since they're not used.

http://codereview.appspot.com/157078/diff/1/3#oldcode1877
Social-Gadget.xml:1877: <section title="BODY"
moved fields to list items, rather than sections.  It takes up less space in the
TOC and it's easier on the eyes.

http://codereview.appspot.com/157078/diff/1/3#oldcode1879
Social-Gadget.xml:1879: <t>&lt;static&gt; Member of:
opensocial.Activity.Field.BODY</t>
Got rid of <static> Member of: opensocial.Foo.Field.BAR throughout.  Was this
adding value for anyone?!

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (right):

http://codereview.appspot.com/157078/diff/1/3#newcode50
Social-Gadget.xml:50: <section title="get"
osapi docs just refer to the parameters in Social-API-Server and the data
objects in Social-Data.  Any discrepencies between client and server side
invocation are listed in this doc.

http://codereview.appspot.com/157078/diff/1/3#newcode1171
Social-Gadget.xml:1171: <section title="Deprecated JavaScript API"
anchor="DeprecatedJavaScriptAPI">
Created an appendix for deprecated methods

http://codereview.appspot.com/157078/diff/1/3#newcode1178
Social-Gadget.xml:1178: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.cache.invalidate">osapi.cache.invalidate()</eref>
instead.</t>
Deprecated classes now have pointers to their replacements

[Jon Weygandt, 2009-11-19 18:39:23]

Looks good.

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (left):

http://codereview.appspot.com/157078/diff/1/3#oldcode44
Social-Gadget.xml:44: <section title="Using the API Reference">
On 2009/11/19 02:23:23, Lane wrote:
> Moved Using the API reference to the Core-Gadget spec.

I did not find this section anywhere on the preview site?

http://codereview.appspot.com/157078/diff/1/3
File Social-Gadget.xml (right):

http://codereview.appspot.com/157078/diff/1/3#newcode57
Social-Gadget.xml:57: <t hangText="Parameters">This method takes a single
parameter, which is a JavaScript object representing the parameters defined by
the <eref target="Social-API-Server.xml#People.get">People service's get
method</eref>.</t>
The eref, used many places, has changed. Maybe you wanted:
#People-Service-GetPerson

[Lane, 2009-11-23 17:40:46]

Thanks for the review Jon.  Responses inline...

On 2009/11/19 18:39:23, Jon Weygandt wrote:
> Looks good.
> 
> http://codereview.appspot.com/157078/diff/1/3
> File Social-Gadget.xml (left):
> 
> http://codereview.appspot.com/157078/diff/1/3#oldcode44
> Social-Gadget.xml:44: <section title="Using the API Reference">
> On 2009/11/19 02:23:23, Lane wrote:
> > Moved Using the API reference to the Core-Gadget spec.
> 
> I did not find this section anywhere on the preview site?

It's in another patch.  FWIW, I've added the section to the preview, but most of
the changes from my Core-Gadget patch are not there yet.
> 
> http://codereview.appspot.com/157078/diff/1/3
> File Social-Gadget.xml (right):
> 
> http://codereview.appspot.com/157078/diff/1/3#newcode57
> Social-Gadget.xml:57: <t hangText="Parameters">This method takes a single
> parameter, which is a JavaScript object representing the parameters defined by
> the <eref target="Social-API-Server.xml#People.get">People service's get
> method</eref>.</t>
> The eref, used many places, has changed. Maybe you wanted:
> #People-Service-GetPerson

yup - fixed.

[Tim Moore, 2009-11-24 01:56:41]

Overall, I'm happy with the changes. I went ahead and tested all of the links,
and noted where they point to missing information. For all I know, those could
be intentional because the docs are still in a transitional state, but I thought
it would be a good idea to catalog them all to be sure that they get fixed up
eventually.

http://codereview.appspot.com/157078/diff/9/2002
File Social-Gadget.xml (right):

http://codereview.appspot.com/157078/diff/9/2002#newcode43
Social-Gadget.xml:43: <section title="JavaScript API Reference"
This seems to be missing APIs for Albums and MediaItems.

http://codereview.appspot.com/157078/diff/9/2002#newcode58
Social-Gadget.xml:58: <t hangText="Returns">A <eref
target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to retrieve
information from the People service. Executing this request MUST return a <eref
target="./Social-Data.xml#Person">Person</eref> object or a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Person">Person</eref> objects.</t>
Should be <eref target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
(different hash)

http://codereview.appspot.com/157078/diff/9/2002#newcode83
Social-Gadget.xml:83: <t hangText="Returns">A <eref
target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to retrieve
information from the People service. Executing this request MUST return a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Person">Person</eref> objects representing the
viewer's friends.</t>
Should be <eref target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
(different hash)

http://codereview.appspot.com/157078/diff/9/2002#newcode108
Social-Gadget.xml:108: <t hangText="Returns">A <eref
target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to retrieve
information from the People service. Executing this request MUST return a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Person">Person</eref> objects representing the owner's
friends.</t>
Should be <eref target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
(different hash)

http://codereview.appspot.com/157078/diff/9/2002#newcode178
Social-Gadget.xml:178: <t hangText="Returns">A <eref
target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to retrieve
information from the Activities service. Executing this request MUST return a
<eref target="./Social-Data.xml#Activity">Activity</eref> object or a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Activity">Activity</eref> objects.</t>
Should be <eref target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
(different hash)

http://codereview.appspot.com/157078/diff/9/2002#newcode323
Social-Gadget.xml:323: <eref
target="./Social-API-Server.xml#Messages-Service">Messages service</eref>.</t>
Just FYI, this section is completely missing from the Social-API-Server.xml
document (most others have at least a stub heading).

http://codereview.appspot.com/157078/diff/9/2002#newcode355
Social-Gadget.xml:355: <t>Namespace for top-level people functions.</t>
This whole section is a little inconsistent about where it puts the xrefs.
Sometimes in the method signature, sometimes in the parameters/returns type
column, sometimes in the description column, sometimes all, sometimes none.

I think it would be best to just chose one location and fix up the section to
use that one consistently. It doesn't really matter which you choose, but all
else equal I would say put them in the Type column, surrounding the type names
there.

http://codereview.appspot.com/157078/diff/9/2002#newcode449
Social-Gadget.xml:449: have its error code set to NOT_IMPLEMENTED.</t>
Does this mean the string "NOT_IMPLEMENTED"? If so, it should be explicit and
say 'the String "NOT_IMPLEMENTED"'. If it refers to a constant that's defined
somewhere, it should xref the constant.

http://codereview.appspot.com/157078/diff/9/2002#newcode465
Social-Gadget.xml:465: <c>Function</c>
Since we use a pseudo-generic syntax for types elsewhere, I think it would be
convenient to define the return and parameter types for any Function parameters.
Something like 'void Function(opensocial.ResponseItem)' (with appropriate xrefs
inserted as necessary).

http://codereview.appspot.com/157078/diff/9/2002#newcode493
Social-Gadget.xml:493: error code set to NOT_IMPLEMENTED.</t></t>
Same comment as with requestPermission, above.

http://codereview.appspot.com/157078/diff/9/2002#newcode509
Social-Gadget.xml:509: <c>Function</c>
Same comment as with opt_callback in requestPermission, above.

http://codereview.appspot.com/157078/diff/9/2002#newcode758
Social-Gadget.xml:758: <t>The Social Gadget Specification extends the Data
Pipelining capabilities of the Core Gadget Specification by adding suport for
the following tags:</t>
It would be helpful to link to the relevant section/document here.
(Core-Gadget.xml#rfc.section.5)

http://codereview.appspot.com/157078/diff/9/2002#newcode765
Social-Gadget.xml:765: <t hangText="Returns">A <eref
target="./Social-Data.xml#Person">Person</eref> object or a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Person">Person</eref> objects.</t>
Should be <eref target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
(different hash)

http://codereview.appspot.com/157078/diff/9/2002#newcode795
Social-Gadget.xml:795: <t hangtext="Returns">A <eref
target="./Social-Data.xml#Activity">Activity</eref> object or a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Activity">Activity</eref> objects.</t>
Should be <eref target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
(different hash)

http://codereview.appspot.com/157078/diff/9/2002#newcode805
Social-Gadget.xml:805: <section title="Templating">
I'm a little unclear... are OpenSocial-Markup-Language-Tags.xml and
OpenSocial-Templating.xml going away? This section doesn't make a lot of sense
to me here.

http://codereview.appspot.com/157078/diff/9/2002#newcode1092
Social-Gadget.xml:1092: <reference anchor='OAuth-Core-1.0'
I don't see a reference to this in the rest of the document. If we're going to
reference the OAuth spec, I think we should reference revision A
(http://oauth.net/core/1.0a) which contains an important security fix.

http://codereview.appspot.com/157078/diff/9/2002#newcode1178
Social-Gadget.xml:1178: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.cache.invalidate">osapi.cache.invalidate()</eref>
instead.</t>
This link doesn't exist in the specified document, and that method isn't
specified in this document either. Is that a planned addition?

http://codereview.appspot.com/157078/diff/9/2002#newcode1227
Social-Gadget.xml:1227: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Album">Album</eref> objects
introduced in OpenSocial v1.0 instead.</t>
Note: Album is still missing from the linked document.

http://codereview.appspot.com/157078/diff/9/2002#newcode1257
Social-Gadget.xml:1257: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.newBatch">osapi.newBatch()</eref>
instead.</t>
Should link to Core-Gadget.xml#osapi.newBatch

http://codereview.appspot.com/157078/diff/9/2002#newcode1372
Social-Gadget.xml:1372: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.activities.create">osapi.activities.create()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.activities.create

http://codereview.appspot.com/157078/diff/9/2002#newcode1416
Social-Gadget.xml:1416: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.messages.send">osapi.messages.send()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.messages.send

http://codereview.appspot.com/157078/diff/9/2002#newcode1452
Social-Gadget.xml:1452: <eref
target="./OpenSocial-Specification.xml#opensocial.NavigationParameters.DestinationType">
Should link to Social-Gadget.xml#opensocial.NavigationParameters.DestinationType

http://codereview.appspot.com/157078/diff/9/2002#newcode1458
Social-Gadget.xml:1458: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.mediaItems.create">osapi.mediaItems.create()</eref>
instead.</t>
This method doesn't seem to exist.

http://codereview.appspot.com/157078/diff/9/2002#newcode1867
Social-Gadget.xml:1867: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Album">Album</eref> objects
introduced in OpenSocial v1.0 instead.</t>
Another broken link to the missing Album definition

http://codereview.appspot.com/157078/diff/9/2002#newcode1922
Social-Gadget.xml:1922: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Album">Album</eref> objects
introduced in OpenSocial v1.0 instead.</t>
Another broken link to the missing Album definition

http://codereview.appspot.com/157078/diff/9/2002#newcode1981
Social-Gadget.xml:1981: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#BodyType">BodyType</eref> objects
introduced in OpenSocial v1.0 instead.</t>
There isn't currently a BodyType object defined in that document. The
description of Person.bodyType says that it's a string. It's not totally clear
to me how the 0.8 enum field types map to the new objects. Right now it kind of
implies that this field can accept any string value.

http://codereview.appspot.com/157078/diff/9/2002#newcode2016
Social-Gadget.xml:2016: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#BodyType">BodyType</eref> objects
introduced in OpenSocial v1.0 instead.</t>
Another broken link to BodyType

http://codereview.appspot.com/157078/diff/9/2002#newcode2056
Social-Gadget.xml:2056: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Collection">Collection</eref>
objects introduced in OpenSocial v1.0 instead.</t>
Should link to Core-Data.xml#OpenSocial-Collection

http://codereview.appspot.com/157078/diff/9/2002#newcode2181
Social-Gadget.xml:2181: <t><x:highlight>Deprecated.</x:highlight> Service
requests should be represented using the <eref
target="./OpenSocial-Specification.xml#osapi.BatchRequest">Batch Request</eref>
JSON object.</t>
Should link to Core-Gadget.xml#osapi.BatchRequest

http://codereview.appspot.com/157078/diff/9/2002#newcode2234
Social-Gadget.xml:2234: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.albums.create">osapi.albums.create()</eref>
instead.</t>
The linked method is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode2262
Social-Gadget.xml:2262: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.mediaItems.create">osapi.mediaItems.create()</eref>
instead.</t>
The linked method is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode2291
Social-Gadget.xml:2291: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.albums.delete">osapi.albums.delete()</eref>
instead.</t>
The linked method is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode2317
Social-Gadget.xml:2317: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.activities.get">osapi.activities.get()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.activities.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2345
Social-Gadget.xml:2345: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.albums.get">osapi.albums.get()</eref>
instead.</t>
The linked method is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode2377
Social-Gadget.xml:2377: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.mediaItems.get">osapi.mediaItems.get()</eref>
instead.</t>
The linked method is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode2413
Social-Gadget.xml:2413: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.people.get">osapi.people.get()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.people.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2444
Social-Gadget.xml:2444: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.appdata.get">osapi.appdata.get()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.appdata.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2481
Social-Gadget.xml:2481: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.people.get">osapi.people.get()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.people.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2513
Social-Gadget.xml:2513: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.appdata.delete">osapi.appdata.delete()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.appdata.delete

http://codereview.appspot.com/157078/diff/9/2002#newcode2537
Social-Gadget.xml:2537: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.albums.update">osapi.albums.update()</eref>
instead.</t>
Linked method is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode2568
Social-Gadget.xml:2568: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.mediaItems.update">osapi.mediaItems.update()</eref>
instead.</t>
Linked method is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode2605
Social-Gadget.xml:2605: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.appdata.update">osapi.appdata.update()</eref>
instead.</t>
Should link to Social-Gadget.xml#osapi.appdata.update

http://codereview.appspot.com/157078/diff/9/2002#newcode2634
Social-Gadget.xml:2634: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.Request.execute">osapi.Request.execute()</eref>
or <eref
target="./OpenSocial-Specification.xml#osapi.BatchRequest.execute">osapi.BatchRequest.execute()</eref>instead.</t>
Should link to Core-Gadget.xml#osapi.Request.execute and
Core-Gadget.xml#osapi.BatchRequest.execute

http://codereview.appspot.com/157078/diff/9/2002#newcode2656
Social-Gadget.xml:2656: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.activities.get">osapi.activities.get()</eref>
with the startIndex, startPage, and count parameters to handle paging.</t>
Should link to Social-Gadget.xml#osapi.activities.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2671
Social-Gadget.xml:2671: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.albums.get">osapi.albums.get()</eref>
with the startIndex, startPage, and count parameters to handle paging.</t>
Link to missing method

http://codereview.appspot.com/157078/diff/9/2002#newcode2701
Social-Gadget.xml:2701: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.people.get">osapi.people.get()</eref>
with the filterBy, filterOp, and filterValue parameters to filter the people
objects returned.</t>
Should link to Social-Gadget.xml#osapi.people.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2734
Social-Gadget.xml:2734: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.mediaItems.get">osapi.mediaItems.get()</eref>
with the startIndex, startPage, and count parameters to handle paging.</t>
Link to missing method

http://codereview.appspot.com/157078/diff/9/2002#newcode2749
Social-Gadget.xml:2749: <list style="hanging">
Several links in the list below should be pointed to
Social-Gadget.xml#osapi.people.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2811
Social-Gadget.xml:2811: <t><x:highlight>Deprecated.</x:highlight> Use <eref
target="./OpenSocial-Specification.xml#osapi.people.get">osapi.people.get()</eref>
with the sortOrder parameter to specify the sort order.</t>
Should link to Social-Gadget.xml#osapi.people.get

http://codereview.appspot.com/157078/diff/9/2002#newcode2829
Social-Gadget.xml:2829: <t><x:highlight>Deprecated.</x:highlight> Callback
methods receive <eref target="./Social-Data.xml#Response">Response</eref>
objects.</t>
Should link to Core-Data.xml#Response

http://codereview.appspot.com/157078/diff/9/2002#newcode2892
Social-Gadget.xml:2892: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Email">Email</eref> objects
introduced in OpenSocial v1.0 instead.</t>
There's no Email object. Looks like the emails field on Person is defined as a
"Plural-Field <string>" now.

http://codereview.appspot.com/157078/diff/9/2002#newcode2927
Social-Gadget.xml:2927: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Email">Email</eref> objects
introduced in OpenSocial v1.0 instead.</t>
Another link to missing Email object

http://codereview.appspot.com/157078/diff/9/2002#newcode4460
Social-Gadget.xml:4460: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Phone">Phone</eref> objects
introduced in OpenSocial v1.0 instead.</t>
There's currently no new Phone object defined. The Person.phoneNumbers field is
defined as Plural-Field <string>

http://codereview.appspot.com/157078/diff/9/2002#newcode4495
Social-Gadget.xml:4495: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Phone">Phone</eref> objects
introduced in OpenSocial v1.0 instead.</t>
Another link to missing Phone object

http://codereview.appspot.com/157078/diff/9/2002#newcode4516
Social-Gadget.xml:4516: <t><x:highlight>Deprecated.</x:highlight> Callback
methods receive <eref target="./Social-Data.xml#Response">Response</eref>
objects.</t>
Response object is missing.

http://codereview.appspot.com/157078/diff/9/2002#newcode4590
Social-Gadget.xml:4590: <t><x:highlight>Deprecated.</x:highlight> Callback
methods receive <eref target="./Social-Data.xml#Response">Response</eref>
objects.</t>
Response object is missing

http://codereview.appspot.com/157078/diff/9/2002#newcode4621
Social-Gadget.xml:4621: <eref
target="./OpenSocial.xml#opensocial.requestPermission">
Should link to Social-Gadget.xml#opensocial.requestPermission

http://codereview.appspot.com/157078/diff/9/2002#newcode4629
Social-Gadget.xml:4629: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Url">Url</eref> objects introduced
in OpenSocial v1.0 instead.</t>
There's no new Url object. URLs are represented as strings according to the
current docs.

http://codereview.appspot.com/157078/diff/9/2002#newcode4664
Social-Gadget.xml:4664: <t><x:highlight>Deprecated.</x:highlight> Use the
definition of <eref target="./Social-Data.xml#Url">Url</eref> objects introduced
in OpenSocial v1.0 instead.</t>
Another link to the missing Url object

[Jon Weygandt, 2009-11-24 02:03:05]

http://codereview.appspot.com/157078/diff/9/2002
File Social-Gadget.xml (right):

http://codereview.appspot.com/157078/diff/9/2002#newcode58
Social-Gadget.xml:58: <t hangText="Returns">A <eref
target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to retrieve
information from the People service. Executing this request MUST return a <eref
target="./Social-Data.xml#Person">Person</eref> object or a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Person">Person</eref> objects.</t>
On 2009/11/24 01:56:41, Tim Moore wrote:
> Should be <eref
target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
> (different hash)

Pertaining to this comment and several others: Looks like I left the
"OpenSocial-" in the Core-Data.xml document. Removed it from the Social-Data.xml
document. Unless there are objections I'll remove the OpenSocial from: Boolean,
Collection, Date, Date-UTC-Offset and Plural-Field, probably on Tuesday.

[Tim Moore, 2009-11-24 18:48:48]

http://codereview.appspot.com/157078/diff/9/2002
File Social-Gadget.xml (right):

http://codereview.appspot.com/157078/diff/9/2002#newcode58
Social-Gadget.xml:58: <t hangText="Returns">A <eref
target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to retrieve
information from the People service. Executing this request MUST return a <eref
target="./Social-Data.xml#Person">Person</eref> object or a <eref
target="./Core-Data.xml#Collection">Collection</eref> of <eref
target="./Social-Data.xml#Person">Person</eref> objects.</t>
On 2009/11/24 02:03:05, Jon Weygandt wrote:
> On 2009/11/24 01:56:41, Tim Moore wrote:
> > Should be <eref
> target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
> > (different hash)
> 
> Pertaining to this comment and several others: Looks like I left the
> "OpenSocial-" in the Core-Data.xml document. Removed it from the
Social-Data.xml
> document. Unless there are objections I'll remove the OpenSocial from:
Boolean,
> Collection, Date, Date-UTC-Offset and Plural-Field, probably on Tuesday.

Sounds good to me

[Lane, 2009-11-25 04:00:35]

Well, the codereview tool seems to have eaten my comments, but I addressed
everything in Tim's review and uploaded a new patch set.

Only high-level thing that was lost was regarding OSML.  I moved the content of
the OSML spec into a "Templating" section of the social gadget spec with the
intent to remove the OSML spec.  Since the Templating spec is pretty long I
figure I'll just link to it from the Core-Gadget spec.

Thanks for the thorough review, Tim!

-Lane

On 2009/11/24 18:48:48, Tim Moore wrote:
> http://codereview.appspot.com/157078/diff/9/2002
> File Social-Gadget.xml (right):
> 
> http://codereview.appspot.com/157078/diff/9/2002#newcode58
> Social-Gadget.xml:58: <t hangText="Returns">A <eref
> target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to retrieve
> information from the People service. Executing this request MUST return a
<eref
> target="./Social-Data.xml#Person">Person</eref> object or a <eref
> target="./Core-Data.xml#Collection">Collection</eref> of <eref
> target="./Social-Data.xml#Person">Person</eref> objects.</t>
> On 2009/11/24 02:03:05, Jon Weygandt wrote:
> > On 2009/11/24 01:56:41, Tim Moore wrote:
> > > Should be <eref
> > target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
> > > (different hash)
> > 
> > Pertaining to this comment and several others: Looks like I left the
> > "OpenSocial-" in the Core-Data.xml document. Removed it from the
> Social-Data.xml
> > document. Unless there are objections I'll remove the OpenSocial from:
> Boolean,
> > Collection, Date, Date-UTC-Offset and Plural-Field, probably on Tuesday.
> 
> Sounds good to me

[Lane, 2009-12-09 21:37:54]

Hey Folks,

I'd like to check in this patch (and several others), so we can get a good
baseline in svn and potentially break up the work a bit.  I've been hesitant
to check things in w/o 5 +1's because we had some commits in v0.9 that
weren't really approved.

Any objections to submitting in-progress patches as long as they're clearly
annotated (a la [Editor's note: This is under discussion at: <link to
thread>] ) where things are in progress or under discussion?

-Lane

(Also...please review this patch and vote!)

On Tue, Nov 24, 2009 at 8:00 PM, <api.lliabraa@gmail.com> wrote:

> Well, the codereview tool seems to have eaten my comments, but I
> addressed everything in Tim's review and uploaded a new patch set.
>
> Only high-level thing that was lost was regarding OSML.  I moved the
> content of the OSML spec into a "Templating" section of the social
> gadget spec with the intent to remove the OSML spec.  Since the
> Templating spec is pretty long I figure I'll just link to it from the
> Core-Gadget spec.
>
> Thanks for the thorough review, Tim!
>
> -Lane
>
>
> On 2009/11/24 18:48:48, Tim Moore wrote:
>
>> http://codereview.appspot.com/157078/diff/9/2002
>> File Social-Gadget.xml (right):
>>
>
>  http://codereview.appspot.com/157078/diff/9/2002#newcode58
>> Social-Gadget.xml:58: <t hangText="Returns">A <eref
>> target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to
>>
> retrieve
>
>> information from the People service. Executing this request MUST
>>
> return a <eref
>
>> target="./Social-Data.xml#Person">Person</eref> object or a <eref
>> target="./Core-Data.xml#Collection">Collection</eref> of <eref
>> target="./Social-Data.xml#Person">Person</eref> objects.</t>
>> On 2009/11/24 02:03:05, Jon Weygandt wrote:
>> > On 2009/11/24 01:56:41, Tim Moore wrote:
>> > > Should be <eref
>> > target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
>> > > (different hash)
>> >
>> > Pertaining to this comment and several others: Looks like I left the
>> > "OpenSocial-" in the Core-Data.xml document. Removed it from the
>> Social-Data.xml
>> > document. Unless there are objections I'll remove the OpenSocial
>>
> from:
>
>> Boolean,
>> > Collection, Date, Date-UTC-Offset and Plural-Field, probably on
>>
> Tuesday.
>
>  Sounds good to me
>>
>
>
>
> http://codereview.appspot.com/157078
>

[snoopdave, 2009-12-10 19:01:20]

+1

- Dave

[Paul Lindner, 2009-12-10 19:25:43]

+1


On Wed, Dec 9, 2009 at 1:37 PM, Lane LiaBraaten <api.lliabraa@gmail.com>wrote:

> Hey Folks,
>
> I'd like to check in this patch (and several others), so we can get a good
> baseline in svn and potentially break up the work a bit.  I've been hesitant
> to check things in w/o 5 +1's because we had some commits in v0.9 that
> weren't really approved.
>
> Any objections to submitting in-progress patches as long as they're clearly
> annotated (a la [Editor's note: This is under discussion at: <link to
> thread>] ) where things are in progress or under discussion?
>
> -Lane
>
> (Also...please review this patch and vote!)
>
> On Tue, Nov 24, 2009 at 8:00 PM, <api.lliabraa@gmail.com> wrote:
>
>> Well, the codereview tool seems to have eaten my comments, but I
>> addressed everything in Tim's review and uploaded a new patch set.
>>
>> Only high-level thing that was lost was regarding OSML.  I moved the
>> content of the OSML spec into a "Templating" section of the social
>> gadget spec with the intent to remove the OSML spec.  Since the
>> Templating spec is pretty long I figure I'll just link to it from the
>> Core-Gadget spec.
>>
>> Thanks for the thorough review, Tim!
>>
>> -Lane
>>
>>
>> On 2009/11/24 18:48:48, Tim Moore wrote:
>>
>>> http://codereview.appspot.com/157078/diff/9/2002
>>> File Social-Gadget.xml (right):
>>>
>>
>>  http://codereview.appspot.com/157078/diff/9/2002#newcode58
>>> Social-Gadget.xml:58: <t hangText="Returns">A <eref
>>> target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to
>>>
>> retrieve
>>
>>> information from the People service. Executing this request MUST
>>>
>> return a <eref
>>
>>> target="./Social-Data.xml#Person">Person</eref> object or a <eref
>>> target="./Core-Data.xml#Collection">Collection</eref> of <eref
>>> target="./Social-Data.xml#Person">Person</eref> objects.</t>
>>> On 2009/11/24 02:03:05, Jon Weygandt wrote:
>>> > On 2009/11/24 01:56:41, Tim Moore wrote:
>>> > > Should be <eref
>>> > target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
>>> > > (different hash)
>>> >
>>> > Pertaining to this comment and several others: Looks like I left the
>>> > "OpenSocial-" in the Core-Data.xml document. Removed it from the
>>> Social-Data.xml
>>> > document. Unless there are objections I'll remove the OpenSocial
>>>
>> from:
>>
>>> Boolean,
>>> > Collection, Date, Date-UTC-Offset and Plural-Field, probably on
>>>
>> Tuesday.
>>
>>  Sounds good to me
>>>
>>
>>
>>
>> http://codereview.appspot.com/157078
>>
>
>  --
> You received this message because you are subscribed to the Google Groups
> "OpenSocial and Gadgets Specification Discussion" group.
> To post to this group, send email to
> opensocial-and-gadgets-spec@googlegroups.com.
> To unsubscribe from this group, send email to
>
opensocial-and-gadgets-spec+unsubscribe@googlegroups.com<opensocial-and-gadge...
> .
> For more options, visit this group at
> http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en.
>

[Lane LiaBraaten, 2009-12-10 20:18:43]

Sweet...I've checked in both Core-Gadget.xml and Social-Gadget.xml

On Thu, Dec 10, 2009 at 11:25 AM, Paul Lindner <lindner@inuus.com> wrote:

> +1
>
>
> On Wed, Dec 9, 2009 at 1:37 PM, Lane LiaBraaten <api.lliabraa@gmail.com>wrote:
>
>> Hey Folks,
>>
>> I'd like to check in this patch (and several others), so we can get a good
>> baseline in svn and potentially break up the work a bit.  I've been hesitant
>> to check things in w/o 5 +1's because we had some commits in v0.9 that
>> weren't really approved.
>>
>> Any objections to submitting in-progress patches as long as they're
>> clearly annotated (a la [Editor's note: This is under discussion at: <link
>> to thread>] ) where things are in progress or under discussion?
>>
>> -Lane
>>
>> (Also...please review this patch and vote!)
>>
>> On Tue, Nov 24, 2009 at 8:00 PM, <api.lliabraa@gmail.com> wrote:
>>
>>> Well, the codereview tool seems to have eaten my comments, but I
>>> addressed everything in Tim's review and uploaded a new patch set.
>>>
>>> Only high-level thing that was lost was regarding OSML.  I moved the
>>> content of the OSML spec into a "Templating" section of the social
>>> gadget spec with the intent to remove the OSML spec.  Since the
>>> Templating spec is pretty long I figure I'll just link to it from the
>>> Core-Gadget spec.
>>>
>>> Thanks for the thorough review, Tim!
>>>
>>> -Lane
>>>
>>>
>>> On 2009/11/24 18:48:48, Tim Moore wrote:
>>>
>>>> http://codereview.appspot.com/157078/diff/9/2002
>>>> File Social-Gadget.xml (right):
>>>>
>>>
>>>  http://codereview.appspot.com/157078/diff/9/2002#newcode58
>>>> Social-Gadget.xml:58: <t hangText="Returns">A <eref
>>>> target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to
>>>>
>>> retrieve
>>>
>>>> information from the People service. Executing this request MUST
>>>>
>>> return a <eref
>>>
>>>> target="./Social-Data.xml#Person">Person</eref> object or a <eref
>>>> target="./Core-Data.xml#Collection">Collection</eref> of <eref
>>>> target="./Social-Data.xml#Person">Person</eref> objects.</t>
>>>> On 2009/11/24 02:03:05, Jon Weygandt wrote:
>>>> > On 2009/11/24 01:56:41, Tim Moore wrote:
>>>> > > Should be <eref
>>>> > target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
>>>> > > (different hash)
>>>> >
>>>> > Pertaining to this comment and several others: Looks like I left the
>>>> > "OpenSocial-" in the Core-Data.xml document. Removed it from the
>>>> Social-Data.xml
>>>> > document. Unless there are objections I'll remove the OpenSocial
>>>>
>>> from:
>>>
>>>> Boolean,
>>>> > Collection, Date, Date-UTC-Offset and Plural-Field, probably on
>>>>
>>> Tuesday.
>>>
>>>  Sounds good to me
>>>>
>>>
>>>
>>>
>>> http://codereview.appspot.com/157078
>>>
>>
>>  --
>> You received this message because you are subscribed to the Google Groups
>> "OpenSocial and Gadgets Specification Discussion" group.
>> To post to this group, send email to
>> opensocial-and-gadgets-spec@googlegroups.com.
>> To unsubscribe from this group, send email to
>>
opensocial-and-gadgets-spec+unsubscribe@googlegroups.com<opensocial-and-gadge...
>> .
>> For more options, visit this group at
>> http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en.
>>
>
>  --
> You received this message because you are subscribed to the Google Groups
> "OpenSocial and Gadgets Specification Discussion" group.
> To post to this group, send email to
> opensocial-and-gadgets-spec@googlegroups.com.
> To unsubscribe from this group, send email to
>
opensocial-and-gadgets-spec+unsubscribe@googlegroups.com<opensocial-and-gadge...
> .
> For more options, visit this group at
> http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en.
>

[Tim Moore, 2009-12-15 23:06:21]

Sorry that I'm late to this, but +1 from me too

On 2009/12/09 21:37:54, Lane wrote:
> Hey Folks,
> 
> I'd like to check in this patch (and several others), so we can get a good
> baseline in svn and potentially break up the work a bit.  I've been hesitant
> to check things in w/o 5 +1's because we had some commits in v0.9 that
> weren't really approved.
> 
> Any objections to submitting in-progress patches as long as they're clearly
> annotated (a la [Editor's note: This is under discussion at: <link to
> thread>] ) where things are in progress or under discussion?
> 
> -Lane
> 
> (Also...please review this patch and vote!)
> 
> On Tue, Nov 24, 2009 at 8:00 PM, <mailto:api.lliabraa@gmail.com> wrote:
> 
> > Well, the codereview tool seems to have eaten my comments, but I
> > addressed everything in Tim's review and uploaded a new patch set.
> >
> > Only high-level thing that was lost was regarding OSML.  I moved the
> > content of the OSML spec into a "Templating" section of the social
> > gadget spec with the intent to remove the OSML spec.  Since the
> > Templating spec is pretty long I figure I'll just link to it from the
> > Core-Gadget spec.
> >
> > Thanks for the thorough review, Tim!
> >
> > -Lane
> >
> >
> > On 2009/11/24 18:48:48, Tim Moore wrote:
> >
> >> http://codereview.appspot.com/157078/diff/9/2002
> >> File Social-Gadget.xml (right):
> >>
> >
> >  http://codereview.appspot.com/157078/diff/9/2002#newcode58
> >> Social-Gadget.xml:58: <t hangText="Returns">A <eref
> >> target="Core-Gadget.xml#osapi.Request">osapi.Request</eref> to
> >>
> > retrieve
> >
> >> information from the People service. Executing this request MUST
> >>
> > return a <eref
> >
> >> target="./Social-Data.xml#Person">Person</eref> object or a <eref
> >> target="./Core-Data.xml#Collection">Collection</eref> of <eref
> >> target="./Social-Data.xml#Person">Person</eref> objects.</t>
> >> On 2009/11/24 02:03:05, Jon Weygandt wrote:
> >> > On 2009/11/24 01:56:41, Tim Moore wrote:
> >> > > Should be <eref
> >> > target="./Core-Data.xml#OpenSocial-Collection">Collection</eref>
> >> > > (different hash)
> >> >
> >> > Pertaining to this comment and several others: Looks like I left the
> >> > "OpenSocial-" in the Core-Data.xml document. Removed it from the
> >> Social-Data.xml
> >> > document. Unless there are objections I'll remove the OpenSocial
> >>
> > from:
> >
> >> Boolean,
> >> > Collection, Date, Date-UTC-Offset and Plural-Field, probably on
> >>
> > Tuesday.
> >
> >  Sounds good to me
> >>
> >
> >
> >
> > http://codereview.appspot.com/157078
> >
>