andrewcurioso / raml-serverless

Work with RAML documentation for Serverless v1.0 projects
https://www.npmjs.com/package/raml-serverless
MIT License
21 stars 2 forks source link

How do you document a URI parameter? #12

Open mrfishy opened 7 years ago

mrfishy commented 7 years ago

RAML has a mechanism to document URI parameters for a call. I can not figure out how to put this documentation into the server.yml file in such a way that it will show up in the correct spot in the output RAML file. Am I missing something, or does raml-serverless not yet support this?

In the RAML file, the uriParameters: tag should be between the path and the HTTP action. However, by the time we are specifying the "documentation:\n raml:" tag in our server.yml file, we are already specifying information related to the method itself.

If raml-serverless can't do this then please consider this a feature request.

andrewcurioso commented 7 years ago

@mrfishy Good question. It can be done. I will add it to the documentation later tonight and update this issue.

mrfishy commented 7 years ago

@andrewcurioso Fantastic! Thank you.