1c21b8575b
The API itself is documented using Swagger, a lightweight mechanism for documenting RESTful API's using JSON. This allows us to use swagger-ui to provide executable documentation for the API, generate client bindings in different languages, and generate a lot of the boilerplate code for implementing the RESTful bindings. The API docs live in the rest-api/ directory. The RESTful bindings are generated from the Swagger API docs using a set of Mustache templates. The code generator is written in Python, and uses Pystache. Pystache has no dependencies, and be installed easily using pip. Code generation code lives in rest-api-templates/. The generated code reduces a lot of boilerplate when it comes to handling HTTP requests. It also helps us have greater consistency in the REST API. (closes issue ASTERISK-20891) Review: https://reviewboard.asterisk.org/r/2376/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@386232 65c4cc65-6c06-0410-ace0-fbb531ad65f3
26 lines
973 B
Text
26 lines
973 B
Text
[general]
|
|
enabled = yes ; When set to no, stasis-http support is disabled
|
|
;pretty = no ; When set to yes, responses from stasis-http are
|
|
; ; formatted to be human readable
|
|
;allowed_origins = ; Comma separated list of allowed origins, for
|
|
; ; Cross-Origin Resource Sharing. May be set to * to allow
|
|
; ; all origins.
|
|
|
|
;[user-username]
|
|
;read_only = no ; When set to yes, user is only authorized for
|
|
; ; read-only requests
|
|
;
|
|
; If a password is specified, user must authenticate using HTTP Basic
|
|
; authentication. If no password is specified, then the user may authenticate
|
|
; simply by adding ?api_key=username to their requests.
|
|
;
|
|
;password = ; Crypted or plaintext password (see crypt_password)
|
|
;
|
|
; crypt_password may be set to crypt (the default) or plain. When set to crypt,
|
|
; crypt(3) is used to encrypt the password. A crypted password can be generated
|
|
; using mkpasswd -m sha-512.
|
|
;
|
|
; When set to plain, the password is in plaintext
|
|
;
|
|
;crypt_password = plain
|