hsztul
commented
12 years ago yeah, we need to have a capistrano task that regenerates docs on deploy. will look into it,
Henry
On Monday, July 30, 2012 at 8:10 PM, Mark Johnson wrote:
was talking to @ArtSabintsev about an iOS issue... noticed that the YARD doc and the actual API doc don't match.
From: http://api.gt.shelby.tv:8080/docs/V1/FrameController
- (Object) create
Creates and returns one frame, with the given parameters.
REQUIRES AUTHENTICATION POST /v1/roll/:roll_id/frames If trying to re-roll: If trying to add a frame via a url: Returns: The new Frame, including all children expanded.
Parameters: frame_id (Required, String) — A frame to be re_rolled url (Required, Escaped String) — A video url text (Optional, Escaped String) — Message text to via added to the conversation source (Optional, String) — The source could be bookmarklet, webapp, etc
From the actual API:
Creates and returns one frame, with the given parameters.
REQUIRES AUTHENTICATION
#
[POST] /v1/roll/:roll_id/frames
#
If trying to re-roll:
@param [Required, String] frame_id A frame to be re_rolled
#
If trying to add a frame via a url:
@param [Required, Escaped String] url A video url
@param [Optional, Escaped String] text Message text to via added to the conversation
@param [Optional, String] source The source could be bookmarklet, webapp, etc
#
Returns: The new Frame, including all children expanded.
Not sure if these need to be re-generated, or if YARD is ignoring the additional lines... @hsztul or @spinosa might know.
Reply to this email directly or view it on GitHub: https://github.com/ShelbyTV/shelby_gt/issues/130
was talking to @ArtSabintsev about an iOS issue... noticed that the YARD doc and the actual API doc don't match.
From: http://api.gt.shelby.tv:8080/docs/V1/FrameController
Creates and returns one frame, with the given parameters.
REQUIRES AUTHENTICATION POST /v1/roll/:roll_id/frames If trying to re-roll: If trying to add a frame via a url: Returns: The new Frame, including all children expanded.
Parameters: frame_id (Required, String) — A frame to be re_rolled url (Required, Escaped String) — A video url text (Optional, Escaped String) — Message text to via added to the conversation source (Optional, String) — The source could be bookmarklet, webapp, etc
From the actual API:
Creates and returns one frame, with the given parameters.
REQUIRES AUTHENTICATION
#
[POST] /v1/roll/:roll_id/frames
#
If trying to re-roll:
@param [Required, String] frame_id A frame to be re_rolled
#
If trying to add a frame via a url:
@param [Required, Escaped String] url A video url
@param [Optional, Escaped String] text Message text to via added to the conversation
@param [Optional, String] source The source could be bookmarklet, webapp, etc
#
Returns: The new Frame, including all children expanded.
Not sure if these need to be re-generated, or if YARD is ignoring the additional lines... @hsztul or @spinosa might know.