mill
mill copied to clipboard
erunion
☴ An annotation-based DSL for documenting a REST API.
#### \Api\Response\VideoResponse ``` /** * @api-data play (\Api\Response\PlayResponse, CAPABILITY_PLAY_REPRESENTATION) - Play representation * @api-version >=3.3 * @api-see \Api\Response\PlayResponse::_json play */ ``` #### \Api\Response\PlayResponse ``` /** * @api-data dash (\Api\Response\VideoFileHlsDashResponse) -...
The goal is to be able to indicate that a field, endpoint, parameter etc. is "the wrong way", and has been replaced with a better way. eg from the Vimeo...
With the new MSON work being done in [mill#42](https://github.com/vimeo/mill/issues/42), the current parameter token system is no longer viable. The way it was originally constructed was that it would `str_replace` content...
> Can we make the field names in the description yellow like the body (eg in "Deprecated metadata.connections.activities in the User representation" metadata.connections.activities should be yellow) We should add in...
*This is partly related to https://github.com/vimeo/mill/issues/21.* Right now, the Mill `deprecated` annotation decorator makes it awful to document why something was deprecated. There is also no way to designate that...