[aerogear-dev] Documenting Server Side Interfaces

[Daniel Bevenius]

I've added this docs to the specs section and push it to the staging area:
http://staging.aerogear.org/docs/specs/

I'm not happy with the formatting and I'll see if I can improve this later,
specifically the tables with the response status code are pretty awful at
the moment :(






On 7 November 2012 20:32, Daniel Bevenius <daniel.bevenius at gmail.com> wrote:

> Yeah, that sounds like a good place. I hope to do this tomorrow.
>
>
> On Wednesday, 7 November 2012, Bruno Oliveira wrote:
>
>> Hi Daniel, what do you think about the specification section?
>>
>> Like a new one to the server side here: http://aerogear.org/docs/specs/
>>
>>
>> --
>> "The measure of a man is what he does with power" - Plato
>> -
>> @abstractj
>> -
>> Volenti Nihil Difficile
>>
>>
>>
>> On Tuesday, November 6, 2012 at 12:35 PM, Daniel Bevenius wrote:
>>
>> > > I would say we just need error responses documented for all of the
>> methods and also include 401 which would be returned if they are not
>> authorized to access a secure endpoint no matter the method.
>> >
>> > Thanks Kris, I've added error response code to the doc.
>> >
>> > Any thoughts on where we should put this information?
>> > Does it belong to the spec section or aerogear.org (http://aerogear.org),
>> for example adding a section with the header "Server Side Specifications"
>> and a "REST API" link?
>> >
>> >
>> >
>> > On 6 November 2012 14:04, Kris Borchers <kris at redhat.com (mailto:
>> kris at redhat.com)> wrote:
>> > > Dan,
>> > >
>> > > This looks really nice! I would say we just need error responses
>> documented for all of the methods and also include 401 which would be
>> returned if they are not authorized to access a secure endpoint no matter
>> the method.
>> > >
>> > > Kris
>> > >
>> > > On Nov 6, 2012, at 6:55 AM, Daniel Bevenius <
>> daniel.bevenius at gmail.com (mailto:daniel.bevenius at gmail.com)> wrote:
>> > > > Hi!
>> > > >
>> > > > I've started to document the server side interfaces here:
>> > > > https://gist.github.com/4023803
>> > > >
>> > > > Let me know if you can think of things that are missing.
>> > > >
>> > > > Thanks,
>> > > >
>> > > > /Dan _______________________________________________
>> > > > aerogear-dev mailing list
>> > > > aerogear-dev at lists.jboss.org (mailto:aerogear-dev at lists.jboss.org)
>> > > > https://lists.jboss.org/mailman/listinfo/aerogear-dev
>> > >
>> > >
>> > >
>> > > _______________________________________________
>> > > aerogear-dev mailing list
>> > > aerogear-dev at lists.jboss.org (mailto:aerogear-dev at lists.jboss.org)
>> > > https://lists.jboss.org/mailman/listinfo/aerogear-dev
>> >
>> >
>> > _______________________________________________
>> > aerogear-dev mailing list
>> > aerogear-dev at lists.jboss.org (mailto:aerogear-dev at lists.jboss.org)
>> > https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>>
>>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20121109/32410555/attachment-0001.html