-
-
Notifications
You must be signed in to change notification settings - Fork 273
[Docs] Updated 'Miscellaneous Examples' Section #48
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
Conversation
Signed-off-by: Akanksha Kushwaha <[email protected]>
Signed-off-by: Akanksha Kushwaha <[email protected]>
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.
Thanks for submitting! Some things to take care of.
Thank you for the feedback! |
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.
I love what you have done to provide a better introduction to each example. That was exactly what I was referring to when I asked to provide a more consistent format for examples.
Regarding the code and keywords thanks a lot @gregsdennis for the comments here. Those are the changes we should include. If you need additional inputs feel free to reach out to @gregsdennis or me and we'll help you.
Nice job overall! You are taking our docs to the next level!
Signed-off-by: Akanksha Kushwaha <[email protected]>
Hi @gregsdennis @benjagm, I have updated the PR with the suggested changes. Please let me know what you think about this. 😊 Thank you! |
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.
Very good edits. I've left a few comments.
Thank you!! I'll make the changes and update the PR soon. |
Signed-off-by: Akanksha Kushwaha <[email protected]>
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.
I'm happy with this. I'd like to get a second opinion on one thing.
Signed-off-by: Akanksha Kushwaha <[email protected]>
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.
Everything looks great. The only thing I noticed is this page will benefit from providing an index at the beginning to better help users to understand what to expect. Something like start the page this way instead of providing the first example:
In this page you will find examples illustrating different uses cases to help you get the most out of your JSON Schemas, including:
- A typical minimum schema
- Describing geographical coordinates
- Arrays of things
- Enumerated values
- Regular expression pattern
- Complex object with nested properties
- Conditional validation with dependentRequired
- Conditional validation with dependentSchemas
- Conditional validation with if-else
Signed-off-by: Akanksha Kushwaha <[email protected]>
Thank you! Just updated this. Please let me know if this works 😊 |
Fixed relative urls in the index
Approved! Did a small change to fix relative urls in the index links. Great work again @aku1310! |
Keywords already in use:
$id
,$schema
,title
,properties
,description
,type
,minimum
,maximum
,required
,$defs
, and$ref
.Keywords added:
enum
,pattern
,dependencies
,if
,then
,else
.I have added some examples which showcased the use of other keywords and structures, and were relatively shorter to be added in the miscellaneous section.
I feel like the other examples which use vocabulary for specific application formats, hypermedia, etc. can be made longer to properly show their usage using a specific use case as well.
Please let me know what you think about this.