sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
asterisk/rest-api-templates
History
David M. Lee 32b4e79434 The Swagger 1.2 specification for type extension ended up being 
slightly different than my proposal. Instead of putting an 'extends'
field on the subtype, the base type has a 'subTypes' field, which is a
list of the subTypes. Given that its a messaging model and not an
object model, kinda makes sense.

This patch changes the events.json api-doc, and the python translators
to take the new format into account.

Other changes that are in Swagger 1.2 were not adopted, since the spec
is still in flux, and could change before it's finalized.

A summary of changes to the Swagger-1.2 spec can be found at
https://github.com/wordnik/swagger-core/wiki/1.2-transition.

(closes issue ASTERISK-22440)
Review: https://reviewboard.asterisk.org/r/2909/
........

Merged revisions 401701 from http://svn.asterisk.org/svn/asterisk/branches/12


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@401834 65c4cc65-6c06-0410-ace0-fbb531ad65f3
 		2013-10-24 20:48:17 +00:00
..
README.txt This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
api.wiki.mustache Multiple revisions 400508,400842-400843,400848 2013-10-11 16:36:00 +00:00
ari.make.mustache Rename everything Stasis-HTTP to ARI 2013-07-27 23:11:02 +00:00
ari_model_validators.c.mustache The Swagger 1.2 specification for type extension ended up being 2013-10-24 20:48:17 +00:00
ari_model_validators.h.mustache ARI: Add subscription support 2013-10-04 16:01:48 +00:00
ari_resource.c.mustache Rename everything Stasis-HTTP to ARI 2013-07-27 23:11:02 +00:00
ari_resource.h.mustache ARI - implement allowMultiple for parameters 2013-08-02 14:36:32 +00:00
asterisk_processor.py My doc correction in r400842 had a silly bug. 2013-10-15 13:44:45 +00:00
do-not-edit.mustache This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
make_ari_stubs.py Account for {} in Swagger notes 2013-08-29 16:21:31 +00:00
models.wiki.mustache The Swagger 1.2 specification for type extension ended up being 2013-10-24 20:48:17 +00:00
odict.py This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
param_cleanup.mustache ARI - implement allowMultiple for parameters 2013-08-02 14:36:32 +00:00
param_parsing.mustache ARI: WebSocket event cleanup 2013-08-27 19:19:36 +00:00
res_ari_resource.c.mustache optional_api: Fix linking problems between modules that export global symbols 2013-08-30 13:40:27 +00:00
rest_handler.mustache Rename everything Stasis-HTTP to ARI 2013-07-27 23:11:02 +00:00
swagger_model.py The Swagger 1.2 specification for type extension ended up being 2013-10-24 20:48:17 +00:00
transform.py Update events to use Swagger 1.3 subtyping, and related aftermath 2013-07-03 16:32:41 +00:00

README.txt 

This directory contains templates and template processing code for generating
HTTP bindings for the RESTful API's.

The RESTful API's are declared using [Swagger][swagger]. While Swagger provides
a [code generating toolkit][swagger-codegen], it requires Java to run, which
would be an unusual dependency to require for Asterisk developers.

This code generator is similar, but written in Python. Templates are processed
by using [pystache][pystache], which is a fairly simply Python implementation of
[mustache][mustache].

 [swagger]: https://github.com/wordnik/swagger-core/wiki
 [swagger-codegen]: https://github.com/wordnik/swagger-codegen
 [pystache]: https://github.com/defunkt/pystache
 [mustache]: http://mustache.github.io/