Proposal for 1.0: REST data normalization for title between Album and MediaItem

0 views
Skip to first unread message

goosemanjack

unread,
Oct 16, 2009, 6:47:52 PM10/16/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
There is currently a mis-match between the Album data format and the
MediaItem data format.

http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/REST-API.html#rfc.section.3.6.2

For the title of an item, Album uses "caption" and MediaItem uses
"title"

Proposal is to normalize both Album and MediaItem to use "title"

http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/REST-API.html#XML_format_XSD

Lane

unread,
Oct 28, 2009, 8:35:01 PM10/28/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
-1 Ideally these would be the same, but I don't think it matters
enough to deal with the backwards compatibility headaches.

On Oct 16, 3:47 pm, goosemanjack <cc...@myspace.com> wrote:
> There is currently a mis-match between the Album data format and the
> MediaItem data format.
>
> http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/RES...
>
> For the title of an item, Album uses "caption" and MediaItem uses
> "title"
>
> Proposal is to normalize both Album and MediaItem to use "title"
>
> http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/RES...

Lane

unread,
Oct 29, 2009, 1:21:53 PM10/29/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
Maybe I'd be a +1 on this if there was some plan for migrating from
'caption' to 'title', but a hard cut over sounds like a bad idea.

Is it reasonable to add the 'title' field to the Album object,
deprecate 'caption', but return both 'title' and 'caption'? Other
ideas?

Cheers,
Lane

Paul Lindner

unread,
Oct 29, 2009, 2:07:04 PM10/29/09
to opensocial-an...@googlegroups.com
This speaks to the need to version the REST/RPC endpoints.  Either we need:

  * explict version number in the request (via url param or header)
  * Use XRDS to define versioned endpoints for each opensocial revision.

Neither of these is in scope for 1.0 --  I think adding & deprecating is the proper way to proceed in this case unless there is overwhelming evidence that a particular feature is not in active use.

--

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.



Chris Chabot

unread,
Oct 29, 2009, 7:03:38 PM10/29/09
to opensocial-an...@googlegroups.com
XRDS should really be the solution here, adding version numbers to the query string really is a bit hack-a-thy, and this is exactly the kind of stuff the flexibility of XRDS was made for.

The downside is that hardly any SNS's support XRDS at the moment, making depending on it not entirely viable.

My personal preference would be to punt this until we do have a clear way of how we want to deal with discovery so we can work towards getting container support for it

goosemanjack

unread,
Oct 30, 2009, 4:34:38 AM10/30/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
As Paul said, adding and deprecating would be an appropriate path for
this and all data-format issues across all endpoints. If the feeling
is that we punt this issue, then by the same logic we would punt all
data-format changes. I think that would be a wrong-headed decision,
especially given that we're attempting to call this next rev 1.0. Of
any rev, this would be the one where we make a concerted effort to fix
and stabilize the data formats - before there's widespread adoption.

As far as XRDS goes, that may or may not be the proper path for
version identification. We (meaning MySpace) would have to pick it up
again and re-evaluate. We're currently using distinct version
numbering in the REST path and will designate new endpoints to serve
updated data formats. The cost of adding the desired data format, but
leaving the legacy keys with repeated data is still fairly minimal at
this point. We'd really like to see the data formats cleaned up to
make this rev worthy of its 1.0 designation.
--
clc


On Oct 29, 4:03 pm, Chris Chabot <chab...@google.com> wrote:
> XRDS should really be the solution here, adding version numbers to the query
> string really is a bit hack-a-thy, and this is exactly the kind of stuff the
> flexibility of XRDS was made for.
>
> The downside is that hardly any SNS's support XRDS at the moment, making
> depending on it not entirely viable.
>
> My personal preference would be to punt this until we do have a clear way of
> how we want to deal with discovery so we can work towards getting container
> support for it
>
> On Thu, Oct 29, 2009 at 7:07 PM, Paul Lindner <lind...@inuus.com> wrote:
> > This speaks to the need to version the REST/RPC endpoints.  Either we need:
>
> >   * explict version number in the request (via url param or header)
> >   * Use XRDS to define versioned endpoints for each opensocial revision.
>
> > Neither of these is in scope for 1.0 --  I think adding & deprecating is
> > the proper way to proceed in this case unless there is overwhelming evidence
> > that a particular feature is not in active use.
>
> >> opensocial-and-gadg...@googlegroups.com<opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com>
> >> .
> >> 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-an...@googlegroups.com.
> > To unsubscribe from this group, send email to
> > opensocial-and-gadg...@googlegroups.com<opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com>
> > .

Lane LiaBraaten

unread,
Oct 30, 2009, 1:03:42 PM10/30/09
to opensocial-an...@googlegroups.com
On Fri, Oct 30, 2009 at 1:34 AM, goosemanjack <cc...@myspace.com> wrote:
As Paul said, adding and deprecating would be an appropriate path for
this and all data-format issues across all endpoints.  

I'm down with adding and deprecating.

@Chris Cole - Want to put this into a spec patch so we can vote for real?

-Lane
 
To unsubscribe from this group, send email to opensocial-and-gadg...@googlegroups.com.

goosemanjack

unread,
Nov 2, 2009, 1:35:18 PM11/2/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
I'll work up a spec patch today.
> > <opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com<opensocial-and-gadgets-spec%252Buns...@googlegroups.com>
>
> > > >> .
> > > >> 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-an...@googlegroups.com.
> > > > To unsubscribe from this group, send email to
> > > > opensocial-and-gadg...@googlegroups.com<opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com>
> > <opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com<opensocial-and-gadgets-spec%252Buns...@googlegroups.com>

goosemanjack

unread,
Nov 3, 2009, 5:56:35 PM11/3/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion

Lane LiaBraaten

unread,
Nov 3, 2009, 8:01:53 PM11/3/09
to opensocial-an...@googlegroups.com
+1 - looks good!

To unsubscribe from this group, send email to opensocial-and-gadg...@googlegroups.com.

Chris Chabot

unread,
Nov 4, 2009, 4:24:46 AM11/4/09
to opensocial-an...@googlegroups.com
+0

I'm still concerned about the compatibility issues, we don't have a clear way of versioning requests and documenting different end-points works well for one or two large sites, but doesn't scale to the entire OpenSocial landscape. My long term hope is still to have a loosely coupled social web where any OpenSocial compatible app or website can work with any OS provider, and this doesn't really align to that.

On the other hand the format change is very sane, the difference in key names was a bug, so I'm not against it from that perspective

Lane LiaBraaten

unread,
Nov 10, 2009, 4:50:56 PM11/10/09
to opensocial-an...@googlegroups.com
Reiterating my +1 (and fishing for more votes).  I think this patch is the best approach we have for dealing with the title vs. caption issue.  

-Lane

Jorge Reyes

unread,
Nov 10, 2009, 8:38:35 PM11/10/09
to opensocial-an...@googlegroups.com
+1


Tosh Meston (MySpace)

unread,
Nov 10, 2009, 8:43:18 PM11/10/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
+1 Let's fix it.


On Nov 10, 5:38 pm, Jorge Reyes <jer...@gmail.com> wrote:
> +1
>
> On Tue, Nov 10, 2009 at 1:50 PM, Lane LiaBraaten <lliab...@google.com>wrote:
>
>
>
> > Reiterating my +1 (and fishing for more votes).  I think this patch is the
> > best approach we have for dealing with the title vs. caption issue.
>
> > -Lane
>
> > On Wed, Nov 4, 2009 at 1:24 AM, Chris Chabot <chab...@google.com> wrote:
>
> >> +0
>
> >> I'm still concerned about the compatibility issues, we don't have a clear
> >> way of versioning requests and documenting different end-points works well
> >> for one or two large sites, but doesn't scale to the entire OpenSocial
> >> landscape. My long term hope is still to have a loosely coupled social web
> >> where any OpenSocial compatible app or website can work with any OS
> >> provider, and this doesn't really align to that.
>
> >> On the other hand the format change is very sane, the difference in key
> >> names was a bug, so I'm not against it from that perspective
>
> >>>> > > > <opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com<opensocial-and- gadgets-spec%252Buns...@googlegroups.com>
> >>>> <opensocial-and-gadgets-spec%252Buns...@googlegroups.com<opensocial-an d-gadgets-spec%25252Bun...@googlegroups.com>
>
> >>>> > > > > >> .
> >>>> > > > > >> 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-an...@googlegroups.com.
> >>>> > > > > > To unsubscribe from this group, send email to
> >>>> > > > > > opensocial-and-gadg...@googlegroups.com<opensocial-and-gad gets-spec%2Bunsu...@googlegroups.com>
> >>>> <opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com<opensocial-and- gadgets-spec%252Buns...@googlegroups.com>
>
> >>>> > > > <opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com<opensocial-and- gadgets-spec%252Buns...@googlegroups.com>
> >>>> <opensocial-and-gadgets-spec%252Buns...@googlegroups.com<opensocial-an d-gadgets-spec%25252Bun...@googlegroups.com>
> ...
>
> read more »

Bruno Fonseca

unread,
Nov 11, 2009, 4:53:54 AM11/11/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
+1

On 10 nov, 22:43, "Tosh Meston (MySpace)" <tosh.mes...@gmail.com>
wrote:
> ...
>
> mais »

Arne Roomann-Kurrik

unread,
Nov 11, 2009, 1:24:40 PM11/11/09
to opensocial-an...@googlegroups.com
+1 not ideal but the most direct way to start fixing this issue.

~Arne


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=.



Lane LiaBraaten

unread,
Nov 11, 2009, 1:36:43 PM11/11/09
to opensocial-an...@googlegroups.com

Krunal

unread,
Nov 16, 2009, 9:05:19 PM11/16/09
to OpenSocial - OpenSocial and Gadgets Specification Discussion
+1

On Nov 11, 11:36 am, Lane LiaBraaten <lliab...@google.com> wrote:
> Committed:http://code.google.com/p/opensocial-resources/source/detail?r=1202
>
> On Wed, Nov 11, 2009 at 10:24 AM, Arne Roomann-Kurrik <kur...@google.com>wrote:
>
> > +1 not ideal but the most direct way to start fixing this issue.
>
> > ~Arne
>
> >> gets-spec%2Bunsu...@googlegroups.com<gets-spec%252Buns...@googlegroups.com>
>
> >> > > >>>> <opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com<opensocial-and-gadgets-spec%252Buns...@googlegroups.com><opensocial-and-
> >> gadgets-spec%252Buns...@googlegroups.com<gadgets-spec%25252Bun...@googlegroups.com>
>
> >> > > >>>> > > > <
> >> opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com<opensocial-and-gadgets-spec%252Buns...@googlegroups.com><opensocial-and-
> >> gadgets-spec%252Buns...@googlegroups.com<gadgets-spec%25252Bun...@googlegroups.com>
>
> >> > > >>>> <opensocial-and-gadgets-spec%252Buns...@googlegroups.com<opensocial-and-gadgets-spec%25252Bun...@googlegroups.com><opensocial-an
> >> d-gadgets-spec%25252Bun...@googlegroups.com<d-gadgets-spec%2525252Bu...@googlegroups.com>
>
> >> > > >>>> > > > > >> .
> >> > > >>>> > > > > >> 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-an...@googlegroups.com.
> >> > > >>>> > > > > > To unsubscribe from this group, send email to
>
> >> opensocial-and-gadg...@googlegroups.com<opensocial-and-gadgets-spec%2Bunsu...@googlegroups.com><opensocial-and-gad
> >> gets-spec%2Bunsu...@googlegroups.com<gets-spec%252Buns...@googlegroups.com>
>
> ...
>
> read more »
Reply all
Reply to author
Forward
0 new messages