[0.8.1] Expand & Clarify the RESTful API specification
1 view
Skip to first unread message
Chris Chabot
Jul 22, 2008, 5:18:38 AM7/22/08
to opensocial-an...@googlegroups.com
It has been suggested that the current RESTful API specification doesn't cover every use case, and is probably not specific enough for implementers and consumers of the RESTful service to have a clear picture on how to use it and/or what to expect.
Some of the threads on this topic:
Louis Ryan also added (on a different topic thread):
"I think the issue here is that if the RESTful API implicitly defines CRUD operations on all these types then the semantics of each of those operations needs to be documented or at least stated that they are not defined.... containers are likely to diverge without guidance."
The consensus seems to be that we would like to see the RESTful API specification to be more detailed and, well, specify what exactly to expect from it and go into more detail on the pieces that it inherits from the http / atom / atompub specifications and how their applied here.
However we don't have anyone yet to champion this, so i'm hoping to see someone volunteer :)
Chris Chabot
Jul 22, 2008, 5:39:06 AM7/22/08
to opensocial-an...@googlegroups.com
It's probably best to tag the 'filterBy option is missing from the RESTful API documentation' to this thread, the original message was:
David Primmer
Jul 22, 2008, 12:38:16 PM7/22/08
to opensocial-an...@googlegroups.com
If you're reviewing things, don't forget these posts asking for clarification:
activities
http://groups.google.com/group/opensocial-and-gadgets-spec/browse_thread/thread/9f7cbb93d187763e/
write semantics
http://groups.google.com/group/opensocial-and-gadgets-spec/browse_thread/thread/494f56cfa5761a26/
appdata
http://groups.google.com/group/opensocial-and-gadgets-spec/browse_thread/thread/991116eeab711d72/
davep
Cassie
Jul 22, 2008, 12:39:19 PM7/22/08
to opensocial-an...@googlegroups.com
+1 for the general concept - I agree it isn't detailed or specific enough.
Anybody want to volunteer for coming up with the exact clarifying text?
Anybody want to volunteer for coming up with the exact clarifying text?
chabotc
Jul 30, 2008, 4:21:41 PM7/30/08
to OpenSocial and Gadgets Specification Discussion
This proposal got the required +5 votes (distributed over a number of
threads unfortunately), and John Panzer may have knowingly or
unknowingly volunteered for this job. Let's assist him the best we can
in that effort!
On Jul 22, 11:18 am, Chris Chabot <chab...@xs4all.nl> wrote:
> It has been suggested that the current RESTful API specification
> doesn't cover every use case, and is probably not specific enough for
> implementers and consumers of the RESTful service to have a clear
> picture on how to use it and/or what to expect.
>
> Some of the threads on this topic:http://groups.google.com/group/opensocial-and-gadgets-spec/browse_thr...http://groups.google.com/group/opensocial-and-gadgets-spec/browse_thr...http://groups.google.com/group/opensocial-and-gadgets-spec/msg/136d4f...
threads unfortunately), and John Panzer may have knowingly or
unknowingly volunteered for this job. Let's assist him the best we can
in that effort!
On Jul 22, 11:18 am, Chris Chabot <chab...@xs4all.nl> wrote:
> It has been suggested that the current RESTful API specification
> doesn't cover every use case, and is probably not specific enough for
> implementers and consumers of the RESTful service to have a clear
> picture on how to use it and/or what to expect.
>
Arne Roomann-Kurrik
Jul 30, 2008, 5:49:17 PM7/30/08
to opensocial-an...@googlegroups.com
Chris, for the record, can you list the votes you're counting as being in support for this issue?
~Arne
~Arne
Reply all
Reply to author
Forward
0 new messages