OpenSocial v0.8.1 is official!

[scottk]

OpenSocial v0.8.1 is now official and is available on http://opensocial.org
. There's a new (optional) JSON RPC spec, a bunch of updates to the
RESTful spec, and more. See the Release Notes for details.

Thanks to everyone who participated in this update.

Release notes:
http://www.opensocial.org/Technical-Resources/opensocial-release-notes#TOC-Release-Notes-for-v0.8.1

OpenSocial spec:
http://www.opensocial.org/Technical-Resources/opensocial-spec-v081

RESTful spec:
http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/restful-protocol

RPC spec:
http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/rpc-protocol

[Dan Peterson]

Woot!

Glad we've been able to get through 0.8.1 :)

-Dan

[Chris Chabot]

Nice one scott! Great to see it out there!

[Ropu]

Hi Guys

im working on some improvements in the REST Messaging impl.

And having a fast look, the way services are defined in the doc have some inconsistencies.

In section 5, discovery

we have this
       <Service>
          <Type>http://ns.opensocial.org//2008/opensocial/messages</Type>
          <os:URI-Template>http://api.example.org/messages/{guid}/{selector}</os:URI-Template>
        </Service>
and should be 
<Service>
          <Type>http://ns.opensocial.org//2008/opensocial/messages</Type>
          <os:URI-Template>http://api.example.org/messages/{guid}/outbox/{selector}</os:URI-Template>
        </Service>


and in section 10, messaging
we have this:

<Service>
  <Type>http://ns.opensocial.org/2008/opensocial/messages</Type>
  <os:URI-Template>http://api.example.org/messages/{guid}/outbox/{msgid}</URI-Template>
</Service>

and we should have

<Service>
  <Type>http://ns.opensocial.org/2008/opensocial/messages</Type>
  <os:URI-Template>http://api.example.org/messages/{guid}/outbox/{msgid}</os:URI-Template>
</Service>



i'll try to have the proposal for adding recipients for early this week


thanks


ropu

--
.-. --- .--. ..-
R  o  p  u

[Ropu]

Hi Guys

here is the proposal for the messaging REST calls

http://docs.google.com/Doc?id=dfjz793x_187gm3prnch


also you may want to check this thread
http://mail-archives.apache.org/mod_mbox/incubator-shindig-dev/200809.mbox/browser

Feedback is welcome

bruno

[Scott Seely]

The presence of ‘outbox’ in the XRDS should neither help nor hinder an implementation that reads XRDS. The important part in the URL Template is the parts in the curly braces {}. The following templates should be equally actionable by an implementation that relies on XRDS + URI Templates:

 

<os:URI-Template>http://api.example.org/messages/{guid}/{msgid}</os:URI-Template>

<os:URI-Template>http://api.google.com/messages/{guid}/outbox/{msgid}</os:URI-Template>

<os:URI-Template>http://api.myspace.com/messages?guid={guid}&msgid={msgid}</os:URI-Template>

 

All three express the same information: they tell the client where it can put the {msgid} and {guid} parameters.

 

As a result, there is no change needed for the spec.

[Scott Seely]

Hit send to soon—you are still correct about needing to match up the namespace info in section 10. That is a typo.

 

ScottK: can we fix that?

[Ropu]

My idea there is just for consistency between sections 5 and 10, an to avoid misunderstandings.

No need to change the spec, only put the same template in both examples. (or explain that are the same)

ropu

[scottk]

I fixed the typo in section 10.

Thanks,
ScottK

On Sep 29, 12:11 pm, Ropu <rovagn...@gmail.com> wrote:
> My idea there is just for consistency between sections 5 and 10, an to avoid
> misunderstandings.
>
> No need to change the spec, only put the same template in both examples. (or

> explain that are the *same*)

>
> ropu
>
>
>
> On Mon, Sep 29, 2008 at 4:03 PM, Scott Seely <SSe...@myspace.com> wrote:
> >  The presence of 'outbox' in the XRDS should neither help nor hinder an
> > implementation that reads XRDS. The important part in the URL Template is
> > the parts in the curly braces {}. The following templates should be equally
> > actionable by an implementation that relies on XRDS + URI Templates:
>

> > <os:URI-Template>http://api.example.org/messages/{guid}/{msgid}<http://api.example.org/messages/%7Bguid%7D/%7Bmsgid%7D>
> > </os:URI-Template>
>
> > <os:URI-Template>http://api.google.com/messages/{guid}/outbox/{msgid} <http://api.google.com/messages/%7Bguid%7D/outbox/%7Bmsgid%7D></os:URI-Template>
>
> > <os:URI-Template>http://api.myspace.com/messages?guid={guid}&msgid={msgid} <http://api.myspace.com/messages?guid=%7Bguid%7D&msgid=%7Bmsgid%7D></os:URI-Template>

>
> > All three express the same information: they tell the client where it can
> > put the {msgid} and {guid} parameters.
>
> > As a result, there is no change needed for the spec.
>

> > *From:* opensocial-an...@googlegroups.com [mailto:
> > opensocial-an...@googlegroups.com] *On Behalf Of *Ropu
> > *Sent:* Monday, September 29, 2008 10:42 AM
> > *To:* opensocial-an...@googlegroups.com
> > *Cc:* rodrigo.galla...@gmail.com
> > *Subject:* [opensocial-and-gadgets-spec] Re: OpenSocial v0.8.1 is

> > official!
>
> > Hi Guys
>
> > here is the proposal for the messaging REST calls
>
> >http://docs.google.com/Doc?id=dfjz793x_187gm3prnch
>
> > also you may want to check this thread
>

> >http://mail-archives.apache.org/mod_mbox/incubator-shindig-dev/200809...
>
> > Feedback is welcome
>
> > bruno

>
> >  On Mon, Sep 29, 2008 at 1:42 PM, Ropu <rovagn...@gmail.com> wrote:
>
> > Hi Guys
>
> > im working on some improvements in the REST Messaging impl.
>
> > And having a fast look, the way services are defined in the doc have some
> > inconsistencies.
>
> > In section 5, discovery
>
> > we have this
> >        <Service>

> >           <Type>http://ns.opensocial.org//2008/opensocial/messages<http://ns.opensocial.org/2008/opensocial/messages>
> > </Type>
> >           <os:URI-Template>
> >http://api.example.org/messages/{guid}/{selector}<http://api.example.org/messages/%7Bguid%7D/%7Bselector%7D>

> > </os:URI-Template>
> >         </Service>
> > and should be
> > <Service>

> >           <Type>http://ns.opensocial.org//2008/opensocial/messages<http://ns.opensocial.org/2008/opensocial/messages>
> > </Type>
> >           <os:URI-Template>http://api.example.org/messages/{guid}/<http://api.example.org/messages/%7Bguid%7D/>
> > *outbox/*{selector}</os:URI-Template>

> >         </Service>
>
> > and in section 10, messaging
> > we have this:
>
> > <Service>
> >   <Type>http://ns.opensocial.org/2008/opensocial/messages</Type>

> >   <os:URI-Template>http://api.example.org/messages/{guid}/outbox/{msgid}<http://api.example.org/messages/%7Bguid%7D/outbox/%7Bmsgid%7D>

> > </URI-Template>
> > </Service>
>
> > and we should have
>
> > <Service>
> >   <Type>http://ns.opensocial.org/2008/opensocial/messages</Type>

> >   <os:URI-Template>http://api.example.org/messages/{guid}/outbox/{msgid}<http://api.example.org/messages/%7Bguid%7D/outbox/%7Bmsgid%7D>
> > </*os:*URI-Template>

> > </Service>
>
> > i'll try to have the proposal for adding recipients for early this week
>
> > thanks
>
> > ropu
>

> > On Sun, Sep 28, 2008 at 8:01 AM, Chris Chabot <chab...@google.com> wrote:
>
> > Nice one scott! Great to see it out there!
>

> > On Sat, Sep 27, 2008 at 9:58 PM, Dan Peterson <dpeter...@google.com>

> > wrote:
>
> > Woot!
>
> > Glad we've been able to get through 0.8.1 :)
>
> > -Dan
>
> > On Sat, Sep 27, 2008 at 10:37 AM, scottk <sco...@google.com> wrote:
>
> > OpenSocial v0.8.1 is now official and is available on
> >http://opensocial.org
> > . There's a new (optional) JSON RPC spec, a bunch of updates to the
> > RESTful spec, and more. See the Release Notes for details.
>
> > Thanks to everyone who participated in this update.
>
> > Release notes:
>

> >http://www.opensocial.org/Technical-Resources/opensocial-release-note...

>
> > OpenSocial spec:
> >http://www.opensocial.org/Technical-Resources/opensocial-spec-v081
>
> > RESTful spec:
>

> >http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/re...
>
> > RPC spec:
>
> >http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/rp...

[Louis Ryan]

Ropu

If Im not mistaken you're also pointing out that the 'recipient' field on Message is also not included in the list of fields on Message (REST 11.3.1) because it is not defined in the OpenSocial JS model. And there is the open question of how to specify the recipients for posting messages, specifically : do they go in the body of the request or as a query param. 

The REST spec currently says there is an osapi:Recipients element in the POST body but does not define any schema for this.

The RPC spec says basically the same thing. 

The JS says the recipients go as as an additional param to requestSendMessage.

I definitely agree there is some ambiguity here. I would be fine with altering the OpenSocial JS API to allow recipients to be a field on Message and altering the requestSendMessage signature for 0.9

-Louis

[Ropu]

Yes Louis

There is nothing in the spec yet that defines where to send the recipients in the REST Api

I dont like the idea of sending them in the REST url, since they can be many, it should be in the POST body.

but as you mention, you have some 'inconsistencies' between APIs (JS vs rest/rpc).

Note that in JS the param is not additional, is the first one, and obviously mandatory

<static> requestSendMessage(recipients, message, opt_callback, opt_params)

I sent a proposal for the way we should send the recipients in the xml and json formats (if needed i can add the schema for that too) as mentioned above
http://docs.google.com/Doc?id=dfjz793x_187gm3prnch

I agrre with you in the proposal to change the Messages JS API signature and add recipients in the message.

in fact, having the recpients in the message will allow us send multiple messages (w/different recipients each) in batch with just one requestSendMessageS();

ropu