It seems that section 11.1 of http://www.opensocial.org/Technical-Resources/staging/restful-protocol adds features not found in http://www.opensocial.org/Technical-Resources/staging/opensocial-reference. I would like to see this group consider dropping any inventions in the REST spec and normalizing/adding to the REST spec field names found in the opensocial-reference spec. Given that our only time pressures are self-imposed, we should not rush in getting 0.8.1 out the door.
Here is the specific call out:
Singular fields:
· published (new)
· updated (new)
· birthday (Should normalize with DATE_OF_BIRTH in the JS. Let’s rename to dateOfBirth)
· anniversary (new)
· note (new)
· preferredUsername (new)
· utcOffset (should normalize this with TIME_ZONE in the JS to change TIME_ZONE to UTC_OFFSET)
· connected (should normalize this with NETWORK_PRESENCE in the JS. Let’s rename this one to networkPresence. This way, it’s also not a Boolean, but a broader set of settings like AWAY, CHAT, ONLINE, OFFLINE, etc.)
Plural fields:
· ims (new)
· photos (new) I think we have a better alternative on the 0.9 horizon. The collection of photos sounds like an Album whose type is restricted to opensocial.MediaItem.Type.Image. I think we could reduce this field to an Album ID and keep the overall API a lot cleaner.
· Since the feature doesn’t seem to be integrated across the specs and we probably don’t want to hold things up, we should remove this item.
· relationships (this seems to conflict in name with RELATIONSHIP_STATUS)
· organizations (JS still has SCHOOLS and JOBS broken out. We should be consistent across models.)
· accounts (new)
Several fields found in a JS Person are not found in the RESTful API:
· ABOUT_ME
· AGE
· BODY_TYPE
· BOOKS
· CARS
· CHILDREN
· CURRENT_LOCATION
· DRINKER
· EMAILS
· ETHNICITY
· FASHION
· FOOD
· HAPPIEST_WHEN
· HAS_APP
· HEROES
· HUMOR
· INTERESTS
· JOB_INTERESTS
· JOBS
· LANGUAGES_SPOKEN
· LIVING_ARRANGEMENT
· LOOKING_FOR
· MOVIES
· MUSIC
· PETS
· POLITICAL_VIEWS
· PROFILE_SONG
· PROFILE_URL
· PROFILE_VIDEO
· QUOTES
· RELATIONSHIP_STATUS
· RELIGION
· ROMANCE
· SCARED_OF
· SEXUAL_ORIENTATION
· SMOKER
· SPORTS
· STATUS
· TURN_OFFS
· TURN_ONS
· TV_SHOWS
This again needs to be rectified. All these items are in the schema for the XML format, but we don’t have a defined mechanism in the spec to call these out for @supportedFields. Even though they are optional in implementations and implementations can support these, it would be good to normalize the names of these fields between the JS and REST specs.
Looking at 11.1.3 (Name)
· formatted (JS has ‘UNSTRUCTURED’—the two should agree in name)
· middleName (new) Please note that ‘middle name’ is not common in all cultures and will cause issues.
· Missing ADDITIONAL_NAME (which is probably a more issue free mechanism to handle the ‘middle name’ issue).
11.1.4 (Address)
· formatted vs. UNSTRUCTURED_ADDRESS in the JS. Let’s normalize by setting JS to FORMATTED
· Missing: EXTENDED_ADDRESS, LATITUDE, LONGITUDE, PO_BOX, TYPE
· Other issue: the streetAddress in 11.1.4 claims to subsume many fields that are individually expressed in the opensocial.Address JS. This is inappropriate as the JS has higher quality data. Ex.: with the REST bits, I need to guess what the PO Box is. I don’t do this with the JS.
11.1.5 (Organization)
· department (new)
· location seems to be the equivalent of address. Let’s just make the REST version be address
· Missing: FIELD, SALARY, SUB_FIELD
11.1.6 (Account)
· No equivalent in the JS spec. Let’s drop this item until 0.9.
Scott Seely |
architect |
email sse...@myspace.com |
My apologies. I’ll be tracking this and other issues so they don’t fall through the cracks when we are ready to open discussions for v.Next. To keep my list easy to see, I’ll be posting it to http://wiki.opensocial-templates.org/index.php?title=OpenSocial_Issues. If we have a better/different place to keep these issues, let me know. This particular list is on the RESTful specific page, http://wiki.opensocial-templates.org/index.php?title=Restful_Protocol_Issues.
It’s a wiki, so other folks on the list should feel free to register and list things they are finding.
I've noticed OpenSocial ID spec change is not reflected in "OpenSocial
Specification -- Implementation Version 0.8.1".
Background > Key Concepts > People : A note about user IDs
"The user ID must be alphanumeric (A-Za-z0-9) and must uniquely
identify the user in a container."
should be something like
"The user ID must only contain alphanumeric (A-Za-z0-9) characters,
underscore(_), dot(.) or dash(-) and must uniquely identify the user
in a container."
Eiji
2008/9/5 Arne Roomann-Kurrik <kur...@google.com>:
Should link to http://www.opensocial.org/Technical-Resources/opensocial-spec-v08/gadgets-reference08
or maybe http://www.opensocial.org/Technical-Resources/opensocial-spec-v07/gadgets-spec
Gadgets API reference link on
is broken.
Should link to http://www.opensocial.org/Technical-Resources/opensocial-spec-v08/gadgets-reference08
Here is the updated schema for the Restful Protocol spec.
Thanks for the catch!
From: opensocial-an...@googlegroups.com [mailto:opensocial-an...@googlegroups.com] On Behalf Of Joseph Smarr
Sent: Monday, September 08, 2008 8:33 PM
To: opensocial-an...@googlegroups.com
Arne,
From my point of view, the alignment of REST/reference/PortableContacts can be postponed until post 0.8.1.
From:
opensocial-an...@googlegroups.com
[mailto:opensocial-an...@googlegroups.com] On Behalf Of Arne
Roomann-Kurrik
Sent: Thursday, September 11, 2008 12:27 PM
To: opensocial-an...@googlegroups.com
Subject: [opensocial-and-gadgets-spec] Re: Draft spec documents for
0.8.1 now staged at opensocial.org
Thanks for the feedback on the draft documents! We've gone over the issues and have added all the feedback into the opensocial-templates wiki (http://wiki.opensocial-templates.org/index.php?title=OpenSocial_Issues), and then split changes into two categories:
It looks like I was unclear here. Let’s try again: The REST/PortableContacts relationship is clearly aligned for 0.8.1. I was just acknowledging Louis Ryan’s question of whether to postpone the REST/JS work until post 0.8.1 so that we wind up in this state for 0.9:
PortableContacts aligned with REST aligned with JS.
Sorry for the confusion.
Found a few more bugs in the XSD. So that it is easier for people to track changes and see where the delta’s are, I’ve posted this to http://wiki.opensocial-templates.org/index.php?title=RESTFul_Schema. The delta’s between what we had and the various bug fixes in the schema can be seen by looking at this delta view:
http://wiki.opensocial-templates.org/index.php?title=RESTFul_Schema&diff=384&oldid=383