-
Notifications
You must be signed in to change notification settings - Fork 9.1k
add description to all schemas #2802
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
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 think this is a great idea. I have a couple suggestions that I hope will make some of the descriptions even more helpful.
ok, this might be a bit better now. |
d931c05
to
8ab4f97
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.
Looks good, but one description is still not quite right.
schemas/v3.1/schema-base.yaml
Outdated
@@ -1,3 +1,4 @@ | |||
description: A dialect to use for schemas within OpenAPI documents |
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 isn't a dialect schema. It describes an OpenAPI document where the schemas all use the OpenAPI Schema dialect.
8ab4f97
to
5f8dff8
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.
One of the descriptions is not quite right. In case it's still unclear what that schema is for, there's a better description here, https://json-schema.org/blog/posts/validating-openapi-and-json-schema
175e688
to
6259423
Compare
done. |
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.
The JSON versions need to be updated too.
834722a
to
6f1c55b
Compare
in v3.1 the number of schemas increased considerably, which can be a bit confusing.
6f1c55b
to
12bc151
Compare
Thanks for all the effort, @karenetheridge, and @jdesrosiers for the additional reviews! |
in v3.1 the number of schemas increased considerably, which can be a bit confusing.