Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How do you document a URI parameter? #12

Open
mrfishy opened this issue Jan 26, 2017 · 2 comments
Open

How do you document a URI parameter? #12

mrfishy opened this issue Jan 26, 2017 · 2 comments
Labels

Comments

@mrfishy
Copy link

mrfishy commented Jan 26, 2017

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
Copy link
Owner

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

@mrfishy
Copy link
Author

mrfishy commented Jan 27, 2017

@andrewcurioso Fantastic! Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants