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

Already on GitHub? Sign in to your account

Break Out Parameter Types? #78

Open
gojohnnygo opened this Issue Mar 28, 2013 · 1 comment

Comments

Projects
None yet
2 participants

My company's API has multiple parameter types. We have required (already a flag for that in IODocs) as well as optional, filter, group, etc. parameters.

I've been just adding the parameter type in the description, but it's still hard to see the different groupings. Is there a way to break out the different types of parameters to make it easier to digest?

Johnny

Contributor

challgren commented Jun 25, 2013

I vote for grouping! We sometimes have different parameters based on the client connecting. So instead of having to document 2 different APIs we have group of parameters for each client.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment