Detailed feedback thread: 1-OpenSocial_0_8_Release_Notes.html

1 view
Skip to first unread message

Dan Peterson

unread,
May 9, 2008, 9:29:09 PM5/9/08
to opensocial-and-gadgets-spec
As per below, please use this thread to discuss potential improvements to the release notes:
http://opensocial-and-gadgets-spec.googlegroups.com/web/1-OpenSocial_0_8_Release_Notes.html

-Dan

---------- Forwarded message ----------
From: Dan Peterson <dpet...@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-an...@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: http://groups.google.com/group/opensocial-and-gadgets-spec/files?&sort=name

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):
  • 1 - OpenSocial 0.8 Release Notes
  • 2 - OpenSocial 0.8 Specification
  • 3 - OpenSocial 0.8 RESTful API Specification
  • 4 - gadgets Specification
    • Canonical gadgets XSD
    • Extended gadgets XSD
    • gadgets Message Bundle XSD
  • 5 - opensocial.* 0.8 JS doc
  • 6 - gadgets.* JS doc
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.

You can learn more about the event at: http://opensocialapis.blogspot.com/2008/05/opensocial-summit-may-14th-at.html
The agenda is here: https://docs.google.com/View?docID=dds2mvj3_1vxvsnzfd
(RSVP is here: http://spreadsheets.google.com/viewform?key=pKy6PfiaRD2NIEhpx692Oaw )

Looking forward to your feedback (in the appropriate thread ;),
-Dan


Paul Lindner

unread,
May 14, 2008, 5:41:31 AM5/14/08
to opensocial-an...@googlegroups.com
* Didn't we define a filter for networkPresence? (maybe I'm not
remembering...)

* 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:
> http://opensocial-and-gadgets-spec.googlegroups.com/web/1-OpenSocial_0_8_Release_Notes.html
>
> -Dan
>

> From: Dan Peterson <dpet...@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-an...@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:
> http://groups.google.com/group/opensocial-and-gadgets-spec/files?&sort=name
>
> 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):
>

> - 1 - OpenSocial 0.8 Release Notes
> - 2 - OpenSocial 0.8 Specification
> - 3 - OpenSocial 0.8 RESTful API Specification
> - 4 - gadgets Specification
> - Canonical gadgets XSD
> - Extended gadgets XSD
> - gadgets Message Bundle XSD
> - 5 - opensocial.* 0.8 JS doc
> - 6 - gadgets.* JS doc


>
> 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.
>
> You can learn more about the event at:
> http://opensocialapis.blogspot.com/2008/05/opensocial-summit-may-14th-at.html
> The agenda is here: https://docs.google.com/View?docID=dds2mvj3_1vxvsnzfd
> (RSVP is here:
> http://spreadsheets.google.com/viewform?key=pKy6PfiaRD2NIEhpx692Oaw )
>
> 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-an...@googlegroups.com
> To unsubscribe from this group, send email to opensocial-and-gadg...@googlegroups.com
> For more options, visit this group at http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en
> -~----------~----~----~----~------~----~------~--~---
>

--
Paul Lindner ||||| | | | | | | | | |
lin...@inuus.com

Dan Peterson

unread,
May 22, 2008, 1:10:02 PM5/22/08
to opensocial-an...@googlegroups.com
On Wed, May 14, 2008 at 2:41 AM, Paul Lindner <lin...@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
 

Arne Roomann-Kurrik (Google)

unread,
May 23, 2008, 9:11:32 PM5/23/08
to OpenSocial and Gadgets Specification Discussion
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:
>
> >http://opensocial-and-gadgets-spec.googlegroups.com/web/1-OpenSocial_...
>
> > > -Dan
>
> > > 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-an...@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:
>
> >http://groups.google.com/group/opensocial-and-gadgets-spec/files?&sor...
> >http://opensocialapis.blogspot.com/2008/05/opensocial-summit-may-14th...
> > > The agenda is here:
> >https://docs.google.com/View?docID=dds2mvj3_1vxvsnzfd
> > > (RSVP is here:
> > >http://spreadsheets.google.com/viewform?key=pKy6PfiaRD2NIEhpx692Oaw)
>
> > > 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-an...@googlegroups.com
> > > To unsubscribe from this group, send email to
> > opensocial-and-gadg...@googlegroups.com
> > > For more options, visit this group at
> >http://groups.google.com/group/opensocial-and-gadgets-spec?hl=en
> > > -~----------~----~----~----~------~----~------~--~---
>
> > --
> > Paul Lindner ||||| | | | | | | | | |
> > lind...@inuus.com

Dan Peterson

unread,
May 23, 2008, 9:38:23 PM5/23/08
to opensocial-an...@googlegroups.com
Good suggestions.

Thanks,
-Dan

David Glazer

unread,
May 26, 2008, 10:23:18 PM5/26/08
to opensocial-an...@googlegroups.com
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

John Hjelmstad

unread,
May 27, 2008, 6:44:27 PM5/27/08
to opensocial-an...@googlegroups.com
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
Reply all
Reply to author
Forward
0 new messages