add description to all schemas #2802
Conversation
jdesrosiers
left a comment
jdesrosiers
left a comment
There was a problem hiding this comment.
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. |
karenetheridge
force-pushed
the
ether/describe-schemas
branch
from
d931c05 to
8ab4f97
Compare
jdesrosiers
left a comment
jdesrosiers
left a comment
There was a problem hiding this comment.
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.
This isn't a dialect schema. It describes an OpenAPI document where the schemas all use the OpenAPI Schema dialect.
karenetheridge
force-pushed
the
ether/describe-schemas
branch
from
8ab4f97 to
5f8dff8
Compare
jdesrosiers
left a comment
jdesrosiers
left a comment
There was a problem hiding this comment.
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
karenetheridge
force-pushed
the
ether/describe-schemas
branch
2 times, most recently
from
175e688 to
6259423
Compare
|
done. |
jdesrosiers
left a comment
jdesrosiers
left a comment
There was a problem hiding this comment.
The JSON versions need to be updated too.
karenetheridge
force-pushed
the
ether/describe-schemas
branch
from
834722a to
6f1c55b
Compare
in v3.1 the number of schemas increased considerably, which can be a bit confusing.
karenetheridge
force-pushed
the
ether/describe-schemas
branch
from
6f1c55b to
12bc151
Compare
|
Thanks for all the effort, @karenetheridge, and @jdesrosiers for the additional reviews! |
4 participants
in v3.1 the number of schemas increased considerably, which can be a bit confusing.