-
Notifications
You must be signed in to change notification settings - Fork 22
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 docs describing the process of writing a new schema #375
Add docs describing the process of writing a new schema #375
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #375 +/- ##
=======================================
Coverage 95.38% 95.38%
=======================================
Files 4 4
Lines 195 195
=======================================
Hits 186 186
Misses 9 9 ☔ View full report in Codecov by Sentry. |
31265be
to
65ac0fd
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a very useful write up. I left a few minor comments inline.
In addition, perhaps there needs to be a mention that schemas in general use indentation with the convention being 2 spaces. I've seen this trip new contributors.
Sometimes you might want to have a field which is required, but which | ||
may not take on any values at all. In this case you can use the | ||
``null`` type as one of the possibilities in the ``oneOf`` combiner. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worth mentioning anyOf
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently we are only using the oneOf
combiner.
This PR addresses a request to add some documentation on how to create a schema.
Checklist
CHANGES.rst
under the corresponding subsection