Update jsonschema2md.py#1
Open
acfischer42 wants to merge 1 commit into
Open
Conversation
Adding Required or Optional. Adding several extra keys: - multipleof -minItems -maxItems -minLength -maxlength -pattern -title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding Required or Optional.
Adding several extra keys:
-maxItems
-minLength
-maxlength
-pattern
-title
Why: JSONSchema includes more keys that can be used to describe the data and these should be documented as well
Implementation:
-Required: since required status is on the higher hierarchy level, passing the required status to the function parse_object and then assembling it to the description line.
-other keys are added analog to the existing ones.
to the description line appends for readability.
Testing: using a JSONSchema that includes the newly implemented keys.