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

[JSON Schema Draft-06] "const" keyword does not reflect to docs? #336

Open
rinov opened this issue Aug 3, 2018 · 1 comment
Open

[JSON Schema Draft-06] "const" keyword does not reflect to docs? #336

rinov opened this issue Aug 3, 2018 · 1 comment

Comments

@rinov
Copy link

rinov commented Aug 3, 2018

I tested generating documentation using const keyword of JSON Schema Draft-06, but it doesn't reflect to docs. (prmd verify schema.json was passed)

For instance, Description and Example are auto generated if using enum keyword like this.

[schema.json]

...
""
"enum": ["THIS-IS-A-CONSTANT"]
...

and $ prmd doc schema.json > schema.md

Description Example
one of:"THIS-IS-A-CONSTANT" "THIS-IS-A-CONSTANT"

In case of const keyword:

Description Example

It'd be nice if it support by default.

Thank you.

@geemus
Copy link
Member

geemus commented Aug 3, 2018

Could you share an example of how you are using const and perhaps what you would like it to look like in the docs? Just want to make sure we are on the same page. Thanks!

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

No branches or pull requests

2 participants