raml-serverless icon indicating copy to clipboard operation
raml-serverless copied to clipboard

How do you document a URI parameter?

Open mrfishy opened this issue 8 years ago • 2 comments

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.

mrfishy avatar Jan 26 '17 21:01 mrfishy

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

andrewcurioso avatar Jan 27 '17 15:01 andrewcurioso

@andrewcurioso Fantastic! Thank you.

mrfishy avatar Jan 27 '17 15:01 mrfishy