Re: [Mailman-Developers] REST API first pass at Swagger spec

2015-01-10 Thread Stephen J. Turnbull
Andrew Stuart writes: > The Swagger spec defines a way to document the methods, properties > and return values of a REST API using JSON, Aha. The Systers' students will like that, I think! Thank you! ___ Mailman-Developers mailing list Mailman-Devel

Re: [Mailman-Developers] REST API first pass at Swagger spec

2015-01-10 Thread Andrew Stuart
The Swagger spec defines a way to document the methods, properties and return values of a REST API using JSON, and also provides a front end user interface to turn that JSON into a functioning user interface to directly query the API. There seems to be a few choices for documentation REST APIs a

[Mailman-Developers] REST API first pass at Swagger spec

2015-01-10 Thread Stephen J. Turnbull
Andrew Stuart writes: > Attached is a first pass at a Swagger spec for the REST API. > > You can find out about Swagger at http://swagger.io tmc;wr[1] Please explain briefly what Swagger is and why you're using it rather than some similar product. Two lines is enough. I have ZERO intention

[Mailman-Developers] REST API first pass at Swagger spec

2015-01-10 Thread Andrew Stuart
Attached is a first pass at a Swagger spec for the REST API. You can find out about Swagger at http://swagger.io The Swagger spec that I am working on is attached to this message or can be found here: http://www.mailripper.com/api-docs.json If you want to see the attached spec in action against

Re: [Mailman-Developers] REST API returns are plain text for errors, JSON or nothing for successful

2015-01-10 Thread Abhilash Raj
On Sunday 11 January 2015 12:53 AM, Andrew Stuart wrote: > Hmmm. > > Happy to do so if you like. Would you mind pointing me in the direction of > some instructions for filing bugs please? https://bugs.launchpad.net/mailman/3.0/+bugs -- thanks, Abhilash Raj

Re: [Mailman-Developers] REST API returns are plain text for errors, JSON or nothing for successful

2015-01-10 Thread Andrew Stuart
Hmmm. Happy to do so if you like. Would you mind pointing me in the direction of some instructions for filing bugs please? FWIW I’d probably favor a REST API that is behaving improperly by returning plain text error responses (i.e. the current situation) rather than a REST API that returns ap

Re: [Mailman-Developers] REST API returns are plain text for errors, JSON or nothing for successful

2015-01-10 Thread Barry Warsaw
On Jan 11, 2015, at 06:06 AM, Andrew Stuart wrote: >I don’t think it’s a big deal in the short term because the plain text error >message can easily be read from the response. > >The only thing that’s somewhat odd is that the content-type is >application/json even though the content isn’t (for err

Re: [Mailman-Developers] REST API returns are plain text for errors, JSON or nothing for successful

2015-01-10 Thread Andrew Stuart
I don’t think it’s a big deal in the short term because the plain text error message can easily be read from the response. The only thing that’s somewhat odd is that the content-type is application/json even though the content isn’t (for error messages). On 11 Jan 2015, at 5:39 am, Barry Warsa

Re: [Mailman-Developers] REST API returns are plain text for errors, JSON or nothing for successful

2015-01-10 Thread Barry Warsaw
On Jan 10, 2015, at 03:42 PM, Andrew Stuart wrote: >Successful requests to the REST API return a 2xx HTTP code to indicate >success either with or without JSON data depending on the context of the >request. > >At least one (I’ve not checked the othes yet) 4xx error returned from the >REST API retu

Re: [Mailman-Developers] REST API returning value of password field in user record

2015-01-10 Thread Barry Warsaw
On Jan 10, 2015, at 01:57 PM, Stephen J. Turnbull wrote: >In the long run we need to do something about this. However, Mailman >has operated based on passing around *cleartext* passwords by *email* >for decades, with no serious issues that I know of. Just to be, ahem, clear, by default MM3 does

Re: [Mailman-Developers] English in UTF-8

2015-01-10 Thread Stephen J. Turnbull
Mark Sapiro writes: > I feel your pain. :-) It's possible to do something about it, though. > The short answer is Yes. Python's email package encodes things based on > character set. Thanks for the quick response. I'll take a look at this. At latest, I'll sprint on it. :-) __