Skip to content

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

Merged
merged 1 commit into from
Feb 24, 2022

Conversation

karenetheridge
Copy link
Member

in v3.1 the number of schemas increased considerably, which can be a bit confusing.

Copy link
Contributor

@jdesrosiers jdesrosiers left a 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.

@karenetheridge
Copy link
Member Author

ok, this might be a bit better now.

Copy link
Contributor

@jdesrosiers jdesrosiers left a 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.

@@ -1,3 +1,4 @@
description: A dialect to use for schemas within OpenAPI documents
Copy link
Contributor

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.

Copy link
Contributor

@jdesrosiers jdesrosiers left a 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

@karenetheridge karenetheridge force-pushed the ether/describe-schemas branch 2 times, most recently from 175e688 to 6259423 Compare February 11, 2022 01:59
@karenetheridge
Copy link
Member Author

done.

Copy link
Contributor

@jdesrosiers jdesrosiers left a 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.

in v3.1 the number of schemas increased considerably, which can be a bit confusing.
@webron webron merged commit 80c781e into OAI:main Feb 24, 2022
@webron
Copy link
Member

webron commented Feb 24, 2022

Thanks for all the effort, @karenetheridge, and @jdesrosiers for the additional reviews!

@karenetheridge karenetheridge deleted the ether/describe-schemas branch February 25, 2022 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants