[asterisk-dev] [Code Review] 3692: ARI: Improvements To Documentation

[Samuel Galarneau]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/3692/
-----------------------------------------------------------

Review request for Asterisk Developers.


Bugs: ASTERISK-23975
    https://issues.asterisk.org/jira/browse/ASTERISK-23975


Repository: Asterisk


Description
-------

The userEvent operation on the events resource fails to mention that the variables body parameter must be wrapped in a variables key in order for custom variables to be sent to the custom user event. This adds documentation to make this clear.

In addition, the originate and originate with id operations on the channels resource show single quotes in the example json, which is invalid (sending the example json to ARI results in an error parsing request body). This changes the examples to show properly formatted json with double quotes.


Diffs
-----

  trunk/rest-api/api-docs/events.json 417717 
  trunk/rest-api/api-docs/channels.json 417717 
  trunk/res/ari/resource_events.h 417717 
  trunk/res/ari/resource_channels.h 417717 

Diff: https://reviewboard.asterisk.org/r/3692/diff/


Testing
-------

Verified that swagger clients can consume the modified json api docs and that the the modified operations are still working correctly.


Thanks,

Samuel Galarneau

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20140701/108026b5/attachment-0001.html>