explore backporting documentation into schema#135
Open
zopalmer14 wants to merge 2 commits intotiger-teamfrom
Open
explore backporting documentation into schema#135zopalmer14 wants to merge 2 commits intotiger-teamfrom
zopalmer14 wants to merge 2 commits intotiger-teamfrom
Conversation
Affected classes: AccessRestriction, CUIRestriction, UseRestriction Changes: - add info from documentation into 'description' fields and/or add '$comment' fields where appropriate - add '_reqLevel' fields to each property in the classes that indicates the requirement level (i.e, M, R, O) - sort the properties by '_reqLevel' - add 'examples' list that includes the complete, typical, and minimal examples for each class - create complete_example.json for AccessRestriction
zopalmer14
added
documentation
Open
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.
Related to: #130
Relevant Documentation: AccessRestriction, CUIRestriction, UseRestriction, NARA Legal Metadata
Affected classes:
AccessRestriction,CUIRestriction,UseRestrictionSummary: I wanted to test out/explore what backporting the DOI-DO/infopolicy documentation into the schema might look like before committing to extending the effort across all of the other classes. The
generate_schema_docs.pyscript would also need to be updated to take into account the new$comment,_reqLevel, andexamplesfields and display them appropriately.Changes:
descriptionfields and/or add$commentfields where appropriate_reqLevelfield to each property in the classes; it indicates each property's requirement level (i.e, "mandatory", "recommended", "optional")_reqLevelexampleslist that includes the complete, typical, and minimal examples for each classcomplete_example.jsonforAccessRestriction