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 an option to show $comments in generated docs #198

Open
nicobo opened this issue May 26, 2023 · 1 comment
Open

Add an option to show $comments in generated docs #198

nicobo opened this issue May 26, 2023 · 1 comment

Comments

@nicobo
Copy link

nicobo commented May 26, 2023

The "human views" of a JSON Schema may include "author" $comment fields on any object.
This may be used to document changes between 2 version or explain the exact purposes of fields for instance.

E.g.

"someObject": {
    "$comment": "This was changed into a string to allow internal references which are not an URI. Having an additional field was rejected because [...].",
    "type": "string",
}

Therefore it would be useful to display the value of $comment fields in the generated docs, possibly activated with a specific option.

@jkowalleck
Copy link

jkowalleck commented Nov 12, 2023

@dblanchette how do you feel about this feature? Is this something this tool should be capable of?

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