diff options
| author | David M. Lee <dlee@digium.com> | 2013-08-02 14:36:32 +0000 |
|---|---|---|
| committer | David M. Lee <dlee@digium.com> | 2013-08-02 14:36:32 +0000 |
| commit | 537ecebd2dc27120144498598f32dec97db6808d (patch) | |
| tree | a3815f8c3f9cc7e2443d8cebc31a7b1d109aa81d /rest-api | |
| parent | 10c91bc96eafbf5f897869ede83127c9c267981c (diff) | |
ARI - implement allowMultiple for parameters
Swagger allows parameters to be specified as 'allowMultiple', meaning
that the parameter may be specified as a comma separated list of
values.
I had written some of the API docs using that, but promptly forgot
about implementing it. This patch finally fills in that gap.
The codegen template was updated to represent 'allowMultiple' fields
as array/size fields in the _args structs. It also parses the comma
separated list using ast_app_separate_args(), so quoted strings in the
argument will be handled properly.
Review: https://reviewboard.asterisk.org/r/2698/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@396122 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/bridges.json | 8 | ||||
| -rw-r--r-- | rest-api/api-docs/channels.json | 2 | ||||
| -rw-r--r-- | rest-api/api-docs/events.json | 2 | ||||
| -rw-r--r-- | rest-api/api-docs/sounds.json | 2 |
4 files changed, 8 insertions, 6 deletions
diff --git a/rest-api/api-docs/bridges.json b/rest-api/api-docs/bridges.json index 7b3c4a37b..57954dd27 100644 --- a/rest-api/api-docs/bridges.json +++ b/rest-api/api-docs/bridges.json @@ -114,7 +114,7 @@ }, { "name": "channel", - "description": "Channel's id", + "description": "Ids of channels to add to bridge", "paramType": "query", "required": true, "allowMultiple": true, @@ -158,7 +158,7 @@ }, { "name": "channel", - "description": "Channel's id", + "description": "Ids of channels to remove from bridge", "paramType": "query", "required": true, "allowMultiple": true, @@ -277,7 +277,7 @@ "description": "Format to encode audio in", "paramType": "query", "required": true, - "allowMultiple": true, + "allowMultiple": false, "dataType": "string" }, { @@ -389,7 +389,7 @@ }, "channels": { "type": "List[string]", - "description": "Id's of channels participating in this bridge", + "description": "Ids of channels participating in this bridge", "required": true } } diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index e54b02772..41b6cc08c 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -634,7 +634,7 @@ "description": "Format to encode audio in", "paramType": "query", "required": true, - "allowMultiple": true, + "allowMultiple": false, "dataType": "string" }, { diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json index 519bb7ae7..a2ac0b3d0 100644 --- a/rest-api/api-docs/events.json +++ b/rest-api/api-docs/events.json @@ -21,7 +21,7 @@ "parameters": [ { "name": "app", - "description": "Comma seperated list of applications to subscribe to.", + "description": "Applications to subscribe to.", "paramType": "query", "required": true, "allowMultiple": true, diff --git a/rest-api/api-docs/sounds.json b/rest-api/api-docs/sounds.json index 103738c45..fe0b09fd4 100644 --- a/rest-api/api-docs/sounds.json +++ b/rest-api/api-docs/sounds.json @@ -19,12 +19,14 @@ "parameters": [ { "name": "lang", + "description": "Lookup sound for a specific language.", "paramType": "query", "dataType": "string", "required": false }, { "name": "format", + "description": "Lookup sound in a specific format.", "paramType": "query", "dataType": "string", "required": false, |