[asterisk-dev] [Code Review] 2937: Update /channels/:id/play documentation and variables

[Mark Michelson]

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


In general, I think that the removal of the "ms" everywhere is a bad idea. Any time that a variable/parameter/etc. has the benefit of being self-documenting, that's a good thing. Removal of "ms" is a step backwards. A parameter called "skip" is much less suggestive of its use instead of "skipms/skip_ms/skipMS/etc." 


trunk/rest-api/api-docs/channels.json
<https://reviewboard.asterisk.org/r/2937/#comment19197>

    Don't mention "audio" here since playback can be used for other media types.



trunk/rest-api/api-docs/channels.json
<https://reviewboard.asterisk.org/r/2937/#comment19196>

    Just my opinion, but I think the previous wording is better.


- Mark Michelson


On Oct. 18, 2013, 7:46 p.m., Paul Belanger wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/2937/
> -----------------------------------------------------------
> 
> (Updated Oct. 18, 2013, 7:46 p.m.)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> Update documentation to avoid some confusing that I had.  I also drop ms from offset and skip, there not camelCase and unneeded IMO.
> 
> 
> Diffs
> -----
> 
>   trunk/res/ari/resource_bridges.h 401041 
>   trunk/res/ari/resource_bridges.c 401041 
>   trunk/res/ari/resource_channels.h 401041 
>   trunk/res/ari/resource_channels.c 401041 
>   trunk/res/res_ari_bridges.c 401041 
>   trunk/res/res_ari_channels.c 401041 
>   trunk/rest-api/api-docs/bridges.json 401041 
>   trunk/rest-api/api-docs/channels.json 401041 
> 
> Diff: https://reviewboard.asterisk.org/r/2937/diff/
> 
> 
> Testing
> -------
> 
> python-ari and swagger
> 
> 
> Thanks,
> 
> Paul Belanger
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20131021/2d6e77a1/attachment.html>