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

Parameters: Description of enumeration elements #119

Closed
honzajavorek opened this issue Sep 9, 2014 · 3 comments
Closed

Parameters: Description of enumeration elements #119

honzajavorek opened this issue Sep 9, 2014 · 3 comments

Comments

@honzajavorek
Copy link
Contributor

Currently, only

+ Values
    + `A`
    + `B`
    + `C`

works. However, people want (1, 2) to document such values separately. Let's say, they want something like

+ Values
    + `A` ... means something
    + `B` ... means something else
    + `C` ... means something completely different

(Just made up the syntax, please do not take it as a real proposal - I assume we need to evaluate the feature request first.)

@zdne
Copy link
Contributor

zdne commented Oct 30, 2014

This is planned.

@pksunkara
Copy link
Contributor

When we align parameters syntax to MSON, this should be achieved by

- country (enum[string])
    - `CZE` - Czech Republic
    - `IND` - India

@zdne zdne changed the title URI Parameters section: Add possibility to document each item in Values enumeration Parameters: Description of enumeration elements Apr 27, 2015
@zdne
Copy link
Contributor

zdne commented Sep 24, 2015

RFC proposal of syntax addressing this issue: apiaryio/api-blueprint-rfcs#3.

Please track and comment on the RFC.

Thank you!

@zdne zdne closed this as completed Sep 24, 2015
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

3 participants