---------- Forwarded message ---------- From: Dan Peterson <dpeter...@google.com> Date: Fri, May 9, 2008 at 6:27 PM Subject: Ready for review: Complete drafts of OpenSocial v0.8 and related
spec updates To: opensocial-and-gadgets-spec < opensocial-and-gadgets-spec@googlegroups.com>
Hi folks,
As discussed last week, the full draft of OpenSocial v0.8 specification is ready for your review. This draft specification includes updates to existing specs, inclusion of the RESTful spec, release notes, and detailed JavaScript doc (JSDoc). The intent was to clearly capture all of the 40+ changes/additions that we have developed on this mailing list since version 0.7 of the spec (as tracked in http://spreadsheets.google.com/pub?key=pigtmOB55Aw_YJHz040u0Kg&gid=0 ). Let's use the next week or two to make improvements to these docs and then we can lock down 0.8.
I have conveniently numbered these documents so it is easier for you to walk through them in a clear order. In addition, documents 1 through 4 have their additions/updates highlighted for ease of reference. To better organize detailed feedback for each document, I will now start a thread for each of the 6 documents. Please be sure to direct your feedback to the appropriate thread.
Also, as a reminder, this coming Wednesday, May 15, we'll be holding an OpenSocial Summit in Mountain View, California. This event is an ideal opportunity to discuss this draft specification, propose ideas for future iterations, and learn about the latest happenings in the community -- as well as get to know each other in person.
> From: Dan Peterson <dpeter...@google.com> > Date: Fri, May 9, 2008 at 6:27 PM > Subject: Ready for review: Complete drafts of OpenSocial v0.8 and related > spec updates > To: opensocial-and-gadgets-spec < > opensocial-and-gadgets-spec@googlegroups.com>
> Hi folks,
> As discussed last week, the full draft of OpenSocial v0.8 specification is > ready for your review. This draft specification includes updates to existing > specs, inclusion of the RESTful spec, release notes, and detailed JavaScript > doc (JSDoc). The intent was to clearly capture all of the 40+ > changes/additions that we have developed on this mailing list since version > 0.7 of the spec (as tracked in > http://spreadsheets.google.com/pub?key=pigtmOB55Aw_YJHz040u0Kg&gid=0 ). > Let's use the next week or two to make improvements to these docs and then > we can lock down 0.8.
> I have conveniently numbered these documents so it is easier for you to walk > through them in a clear order. In addition, documents 1 through 4 have their > additions/updates highlighted for ease of reference. To better organize > detailed feedback for each document, I will now start a thread for each of > the 6 documents. Please be sure to direct your feedback to the appropriate > thread.
> Also, as a reminder, this coming Wednesday, May 15, we'll be holding an > OpenSocial Summit in Mountain View, California. This event is an ideal > opportunity to discuss this draft specification, propose ideas for future > iterations, and learn about the latest happenings in the community -- as > well as get to know each other in person.
> Looking forward to your feedback (in the appropriate thread ;), > -Dan
> 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 > For more options, visit this group at http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en > -~----------~----~----~----~------~----~------~--~---
On Wed, May 14, 2008 at 2:41 AM, Paul Lindner <lind...@inuus.com> wrote: > * Didn't we define a filter for networkPresence? (maybe I'm not > remembering...)
It isn't actually a filter, but it does hang off of the person field.
> * refreshInterval is also availble on makeRequest() calls
> On Fri, May 09, 2008 at 06:29:09PM -0700, Dan Peterson wrote: > > As per below, please use this thread to discuss potential improvements to > > the release notes:
> > From: Dan Peterson <dpeter...@google.com> > > Date: Fri, May 9, 2008 at 6:27 PM > > Subject: Ready for review: Complete drafts of OpenSocial v0.8 and related > > spec updates > > To: opensocial-and-gadgets-spec < > > opensocial-and-gadgets-spec@googlegroups.com>
> > Hi folks,
> > As discussed last week, the full draft of OpenSocial v0.8 specification > is > > ready for your review. This draft specification includes updates to > existing > > specs, inclusion of the RESTful spec, release notes, and detailed > JavaScript > > doc (JSDoc). The intent was to clearly capture all of the 40+ > > changes/additions that we have developed on this mailing list since > version > > 0.7 of the spec (as tracked in > > http://spreadsheets.google.com/pub?key=pigtmOB55Aw_YJHz040u0Kg&gid=0 ). > > Let's use the next week or two to make improvements to these docs and > then > > we can lock down 0.8.
> > You can find all 6 of these documents uploaded into the "Files" section > of > > this Google Group:
> > I have conveniently numbered these documents so it is easier for you to > walk > > through them in a clear order. In addition, documents 1 through 4 have > their > > additions/updates highlighted for ease of reference. To better organize > > detailed feedback for each document, I will now start a thread for each > of > > the 6 documents. Please be sure to direct your feedback to the > appropriate > > thread.
> > Also, as a reminder, this coming Wednesday, May 15, we'll be holding an > > OpenSocial Summit in Mountain View, California. This event is an ideal > > opportunity to discuss this draft specification, propose ideas for future > > iterations, and learn about the latest happenings in the community -- as > > well as get to know each other in person.
> > Looking forward to your feedback (in the appropriate thread ;), > > -Dan
> > 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 > > For more options, visit this group at > http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en > > -~----------~----~----~----~------~----~------~--~---
Looking over the spec, I've noticed a couple places that will make 0.7
gadgets incompatible with 0.8:
* The removal of VIEWER_FRIENDS and OWNER_FRIENDS in favor of the
IdSpec object.
* The change from opensocial.Activity.MediaItem =>
opensocial.MediaItem
* LOOKING_FOR went from string => opensocial.Enum.LookingFor
* newFetchActivitiesRequest returns a Collection<Activity> instead
of an object
Can we highlight these changes in this document, to make porting a bit
more straightforward?
Thanks,
~Arne
On May 22, 10:10 am, "Dan Peterson" <dpeter...@google.com> wrote:
> On Wed, May 14, 2008 at 2:41 AM, Paul Lindner <lind...@inuus.com> wrote:
> > * Didn't we define a filter for networkPresence? (maybe I'm not
> > remembering...)
> It isn't actually a filter, but it does hang off of the person field.
> > * refreshInterval is also availble on makeRequest() calls
> Good catch!
> Thanks,
> -Dan
> > On Fri, May 09, 2008 at 06:29:09PM -0700, Dan Peterson wrote:
> > > As per below, please use this thread to discuss potential improvements to
> > > the release notes:
> > > From: Dan Peterson <dpeter...@google.com>
> > > Date: Fri, May 9, 2008 at 6:27 PM
> > > Subject: Ready for review: Complete drafts of OpenSocial v0.8 and related
> > > spec updates
> > > To: opensocial-and-gadgets-spec <
> > > opensocial-and-gadgets-spec@googlegroups.com>
> > > Hi folks,
> > > As discussed last week, the full draft of OpenSocial v0.8 specification
> > is
> > > ready for your review. This draft specification includes updates to
> > existing
> > > specs, inclusion of the RESTful spec, release notes, and detailed
> > JavaScript
> > > doc (JSDoc). The intent was to clearly capture all of the 40+
> > > changes/additions that we have developed on this mailing list since
> > version
> > > 0.7 of the spec (as tracked in
> > >http://spreadsheets.google.com/pub?key=pigtmOB55Aw_YJHz040u0Kg&gid=0).
> > > Let's use the next week or two to make improvements to these docs and
> > then
> > > we can lock down 0.8.
> > > You can find all 6 of these documents uploaded into the "Files" section
> > of
> > > this Google Group:
> > > I have conveniently numbered these documents so it is easier for you to
> > walk
> > > through them in a clear order. In addition, documents 1 through 4 have
> > their
> > > additions/updates highlighted for ease of reference. To better organize
> > > detailed feedback for each document, I will now start a thread for each
> > of
> > > the 6 documents. Please be sure to direct your feedback to the
> > appropriate
> > > thread.
> > > Also, as a reminder, this coming Wednesday, May 15, we'll be holding an
> > > OpenSocial Summit in Mountain View, California. This event is an ideal
> > > opportunity to discuss this draft specification, propose ideas for future
> > > iterations, and learn about the latest happenings in the community -- as
> > > well as get to know each other in person.
> > > Looking forward to your feedback (in the appropriate thread ;),
> > > -Dan
> > > 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
> > > For more options, visit this group at
> >http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en > > > -~----------~----~----~----~------~----~------~--~---
> Looking over the spec, I've noticed a couple places that will make 0.7 > gadgets incompatible with 0.8:
> * The removal of VIEWER_FRIENDS and OWNER_FRIENDS in favor of the > IdSpec object. > * The change from opensocial.Activity.MediaItem => > opensocial.MediaItem > * LOOKING_FOR went from string => opensocial.Enum.LookingFor > * newFetchActivitiesRequest returns a Collection<Activity> instead > of an object
> Can we highlight these changes in this document, to make porting a bit > more straightforward?
> Thanks, > ~Arne
> On May 22, 10:10 am, "Dan Peterson" <dpeter...@google.com> wrote: > > On Wed, May 14, 2008 at 2:41 AM, Paul Lindner <lind...@inuus.com> wrote: > > > * Didn't we define a filter for networkPresence? (maybe I'm not > > > remembering...)
> > It isn't actually a filter, but it does hang off of the person field.
> > > * refreshInterval is also availble on makeRequest() calls
> > Good catch!
> > Thanks, > > -Dan
> > > On Fri, May 09, 2008 at 06:29:09PM -0700, Dan Peterson wrote: > > > > As per below, please use this thread to discuss potential > improvements to > > > > the release notes:
> > > > From: Dan Peterson <dpeter...@google.com> > > > > Date: Fri, May 9, 2008 at 6:27 PM > > > > Subject: Ready for review: Complete drafts of OpenSocial v0.8 and > related > > > > spec updates > > > > To: opensocial-and-gadgets-spec < > > > > opensocial-and-gadgets-spec@googlegroups.com>
> > > > Hi folks,
> > > > As discussed last week, the full draft of OpenSocial v0.8 > specification > > > is > > > > ready for your review. This draft specification includes updates to > > > existing > > > > specs, inclusion of the RESTful spec, release notes, and detailed > > > JavaScript > > > > doc (JSDoc). The intent was to clearly capture all of the 40+ > > > > changes/additions that we have developed on this mailing list since > > > version > > > > 0.7 of the spec (as tracked in > > > >http://spreadsheets.google.com/pub?key=pigtmOB55Aw_YJHz040u0Kg&gid=0 > ). > > > > Let's use the next week or two to make improvements to these docs and > > > then > > > > we can lock down 0.8.
> > > > You can find all 6 of these documents uploaded into the "Files" > section > > > of > > > > this Google Group:
> > > > The draft documents published are (please note that some of the links > in > > > the > > > > files might not work as this is only a staged copy):
> > > > I have conveniently numbered these documents so it is easier for you > to > > > walk > > > > through them in a clear order. In addition, documents 1 through 4 > have > > > their > > > > additions/updates highlighted for ease of reference. To better > organize > > > > detailed feedback for each document, I will now start a thread for > each > > > of > > > > the 6 documents. Please be sure to direct your feedback to the > > > appropriate > > > > thread.
> > > > Also, as a reminder, this coming Wednesday, May 15, we'll be holding > an > > > > OpenSocial Summit in Mountain View, California. This event is an > ideal > > > > opportunity to discuss this draft specification, propose ideas for > future > > > > iterations, and learn about the latest happenings in the community -- > as > > > > well as get to know each other in person.
> > > > Looking forward to your feedback (in the appropriate thread ;), > > > > -Dan
> > > > 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 > > > > For more options, visit this group at > > >http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en > > > > -~----------~----~----~----~------~----~------~--~---
In addition to highlighting in the spec, do we have a policy on backwards compatibility? In spec-speak, what is the right version of "If the gadget asks for opensocial-0.8, containers { MUST NOT | MAY | SHOULD | MUST } accept the old syntax also." ? (I'm assuming that gadgets that ask for opensocial-0.7 will keep working as long as containers choose to keep supporting it, and that reference implementations like Shindig will make that easy; the question is about gadgets that choose to step forward to 0.8.)
On Fri, May 23, 2008 at 6:38 PM, Dan Peterson <dpeter...@google.com> wrote: > Good suggestions.
> Thanks, > -Dan
> On Fri, May 23, 2008 at 6:11 PM, Arne Roomann-Kurrik (Google) < > api.kur...@google.com> wrote:
>> Looking over the spec, I've noticed a couple places that will make 0.7 >> gadgets incompatible with 0.8:
>> * The removal of VIEWER_FRIENDS and OWNER_FRIENDS in favor of the >> IdSpec object. >> * The change from opensocial.Activity.MediaItem => >> opensocial.MediaItem >> * LOOKING_FOR went from string => opensocial.Enum.LookingFor >> * newFetchActivitiesRequest returns a Collection<Activity> instead >> of an object
>> Can we highlight these changes in this document, to make porting a bit >> more straightforward?
>> Thanks, >> ~Arne
>> On May 22, 10:10 am, "Dan Peterson" <dpeter...@google.com> wrote: >> > On Wed, May 14, 2008 at 2:41 AM, Paul Lindner <lind...@inuus.com> >> wrote: >> > > * Didn't we define a filter for networkPresence? (maybe I'm not >> > > remembering...)
>> > It isn't actually a filter, but it does hang off of the person field.
>> > > * refreshInterval is also availble on makeRequest() calls
>> > Good catch!
>> > Thanks, >> > -Dan
>> > > On Fri, May 09, 2008 at 06:29:09PM -0700, Dan Peterson wrote: >> > > > As per below, please use this thread to discuss potential >> improvements to >> > > > the release notes:
>> > > > From: Dan Peterson <dpeter...@google.com> >> > > > Date: Fri, May 9, 2008 at 6:27 PM >> > > > Subject: Ready for review: Complete drafts of OpenSocial v0.8 and >> related >> > > > spec updates >> > > > To: opensocial-and-gadgets-spec < >> > > > opensocial-and-gadgets-spec@googlegroups.com>
>> > > > Hi folks,
>> > > > As discussed last week, the full draft of OpenSocial v0.8 >> specification >> > > is >> > > > ready for your review. This draft specification includes updates to >> > > existing >> > > > specs, inclusion of the RESTful spec, release notes, and detailed >> > > JavaScript >> > > > doc (JSDoc). The intent was to clearly capture all of the 40+ >> > > > changes/additions that we have developed on this mailing list since >> > > version >> > > > 0.7 of the spec (as tracked in >> > > >http://spreadsheets.google.com/pub?key=pigtmOB55Aw_YJHz040u0Kg&gid=0 >> ). >> > > > Let's use the next week or two to make improvements to these docs >> and >> > > then >> > > > we can lock down 0.8.
>> > > > You can find all 6 of these documents uploaded into the "Files" >> section >> > > of >> > > > this Google Group:
>> > > > The draft documents published are (please note that some of the >> links in >> > > the >> > > > files might not work as this is only a staged copy):
>> > > > I have conveniently numbered these documents so it is easier for you >> to >> > > walk >> > > > through them in a clear order. In addition, documents 1 through 4 >> have >> > > their >> > > > additions/updates highlighted for ease of reference. To better >> organize >> > > > detailed feedback for each document, I will now start a thread for >> each >> > > of >> > > > the 6 documents. Please be sure to direct your feedback to the >> > > appropriate >> > > > thread.
>> > > > Also, as a reminder, this coming Wednesday, May 15, we'll be holding >> an >> > > > OpenSocial Summit in Mountain View, California. This event is an >> ideal >> > > > opportunity to discuss this draft specification, propose ideas for >> future >> > > > iterations, and learn about the latest happenings in the community >> -- as >> > > > well as get to know each other in person.
>> > > > Looking forward to your feedback (in the appropriate thread ;), >> > > > -Dan
>> > > > 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 >> > > > For more options, visit this group at >> > >http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en >> > > > -~----------~----~----~----~------~----~------~--~---
We don't have this right now, but we should carefully consider adding it.
It's incumbent on each version of the spec to define what it means to be compliant with the version of OpenSocial defined therein. We don't have a Backward Compatibility section, so a site can be OpenSocial 0.8 compliant and happily refuse to support 0.7 gadgets if it so chooses.
Each iteration will have to grapple with the trade-off between code maintenance/complexity and wide support for existing gadgets. For cases where the new version is a superset of the previous N versions, the burden is small and N-version backward compatibility makes sense. If we were to fundamentally rewrite how OpenSocial works, the tax might be large enough to discourage adoption.
All pretty obvious, but I wanted to put it out there. That brings us to: do people feel strongly enough about 0.8 backward compatibility with {0.7,0.6,0.5} to warrant adding this section for strict compliance? Or, is it worth adding a SHOULD-style clause for encouragement?
--John
On Mon, May 26, 2008 at 7:23 PM, David Glazer <dgla...@google.com> wrote:
In addition to highlighting in the spec, do we have a policy on backwards compatibility? In spec-speak, what is the right version of "If the gadget asks for opensocial-0.8, containers { MUST NOT | MAY | SHOULD | MUST } accept the old syntax also." ? (I'm assuming that gadgets that ask for opensocial-0.7 will keep working as long as containers choose to keep supporting it, and that reference implementations like Shindig will make that easy; the question is about gadgets that choose to step forward to 0.8.)
- dG
On Fri, May 23, 2008 at 6:38 PM, Dan Peterson <dpeter...@google.com> wrote:
Good suggestions.
Thanks, -Dan
On Fri, May 23, 2008 at 6:11 PM, Arne Roomann-Kurrik (Google) <
Looking over the spec, I've noticed a couple places that will make 0.7 gadgets incompatible with 0.8:
* The removal of VIEWER_FRIENDS and OWNER_FRIENDS in favor of the IdSpec object. * The change from opensocial.Activity.MediaItem => opensocial.MediaItem * LOOKING_FOR went from string => opensocial.Enum.LookingFor * newFetchActivitiesRequest returns a Collection<Activity> instead of an object
Can we highlight these changes in this document, to make porting a bit more straightforward?
Thanks, ~Arne
On May 22, 10:10 am, "Dan Peterson" <dpeter...@google.com> wrote:
> On Wed, May 14, 2008 at 2:41 AM, Paul Lindner <lind...@inuus.com> wrote: > > * Didn't we define a filter for networkPresence? (maybe I'm not > > remembering...)
> It isn't actually a filter, but it does hang off of the person field.
> > * refreshInterval is also availble on makeRequest() calls
> Good catch!
> Thanks, > -Dan
> > On Fri, May 09, 2008 at 06:29:09PM -0700, Dan Peterson wrote: > > > As per below, please use this thread to discuss potential improvements to > > > the release notes:
> > > From: Dan Peterson <dpeter...@google.com> > > > Date: Fri, May 9, 2008 at 6:27 PM > > > Subject: Ready for review: Complete drafts of OpenSocial v0.8 and related > > > spec updates > > > To: opensocial-and-gadgets-spec < > > > opensocial-and-gadgets-spec@googlegroups.com>
> > > Hi folks,
> > > As discussed last week, the full draft of OpenSocial v0.8 specification > > is > > > ready for your review. This draft specification includes updates to > > existing > > > specs, inclusion of the RESTful spec, release notes, and detailed > > JavaScript > > > doc (JSDoc). The intent was to clearly capture all of the 40+ > > > changes/additions that we have developed on this mailing list since > > version > > > 0.7 of the spec (as tracked in > > >http://spreadsheets.google.com/pub?key=pigtmOB55Aw_YJHz040u0Kg&gid=0). > > > Let's use the next week or two to make improvements to these docs and > > then > > > we can lock down 0.8.
> > > You can find all 6 of these documents uploaded into the "Files" section > > of > > > this Google Group:
