You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would be useful to be able to create markdown documentation from JSON Schema.
There are other (excellent) tools in the wild but they have a number of deficiencies or limitations, including one or more of:
They don't provide universal tools that "just work" on Windows/Linux/MacOS without a containerload of dependencies
They don't support all keywords in all drafts from Draft 4 to 2020-12.
They don't link back to canonical documentation
They don't allow you to add additional documentation in external files to target particular schema or elements within the schema (if you are not the owner of the schema itself.)
They don't perform semantic analysis on the types, allowing us to document common patterns e.g. tuple, strongly-typed map, strongly-typed array.
In order to support this we should
Create a MarkdownLanguageProvider implementing ILanguageProvider
Refactor the unnecessary "capabilities" out of ILanguageProvider in the same way as IHierarchicalLanguageProvider so that we don't need NOP implementations of things we don't need (like validation).
Create the provider's Options type that gives us the ability to provide external documentation files
Implement the single code file provider
i. Title
ii. Description
iii. Semantic detail
iv. keywords by classification (e.g. applicator, validation), with hyperlinks to the relevant schema
The text was updated successfully, but these errors were encountered:
It would be useful to be able to create markdown documentation from JSON Schema.
There are other (excellent) tools in the wild but they have a number of deficiencies or limitations, including one or more of:
In order to support this we should
MarkdownLanguageProvider
implementingILanguageProvider
ILanguageProvider
in the same way asIHierarchicalLanguageProvider
so that we don't need NOP implementations of things we don't need (like validation).Options
type that gives us the ability to provide external documentation filescanonical documentation uri
to the IKeyword interface (or possibly to a new "documented keyword" interface, and link to the appropriate docs. e.g. https://www.learnjsonschema.com/2019-09/, https://www.learnjsonschema.com/2020-12i. Title
ii. Description
iii. Semantic detail
iv. keywords by classification (e.g. applicator, validation), with hyperlinks to the relevant schema
The text was updated successfully, but these errors were encountered: