-
Notifications
You must be signed in to change notification settings - Fork 362
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
Update summary field name to description in info objects #275
base: master
Are you sure you want to change the base?
Update summary field name to description in info objects #275
Conversation
@ChristopheDujarric https://bump.sh/christophedujarric/doc/openai is nothing short of a piece of art. I wish all API references were as clean and beautiful this one. |
@ChristopheDujarric I've sent you a PR to your branch with another commit renaming the existing |
Thanks @paulRbr ! |
x-oaiMeta: | ||
name: Create chat completion |
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.
Please don't remove x-oai things
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.
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 @rattrayalex and @paulRbr !
cd2eb64
to
0522091
Compare
This PR updates
summary
field names todescription
in info objects.The OpenAPI specification indeed specifies:
As multiple current summary fields include Markdown descriptions, this change makes it possible to nicely render the definition file in standard vendor tooling on the market. Example: https://bump.sh/christophedujarric/doc/openai