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

Add human readable parameter descriptions to the API parameters #404

Open
Metallion opened this issue Aug 7, 2015 · 0 comments
Open

Add human readable parameter descriptions to the API parameters #404

Metallion opened this issue Aug 7, 2015 · 0 comments

Comments

@Metallion
Copy link
Contributor

Problem

Currently Sinatra-browse generates API documentation showing the parameter names and their possible values etc. but it's still not always clear what the parameters do.

Solution

Sinatra-browse has a feature to describe parameters. We should use it and fill in descriptions for all parameters in OpenVNet. https://github.com/axsh/sinatra-browse#describing-parameters

@Metallion Metallion added this to the v0.9 milestone Aug 7, 2015
@Metallion Metallion self-assigned this Sep 25, 2015
@Metallion Metallion modified the milestone: v0.9 Apr 12, 2016
@Metallion Metallion removed their assignment Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant