Update summary field name to description in info objects #275
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@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 ! |
rattrayalex
reviewed
Jun 11, 2024
| x-oaiMeta: | ||
| name: Create chat completion |
There was a problem hiding this comment.
Please don't remove x-oai things
There was a problem hiding this comment.
There was a problem hiding this comment.
thanks @rattrayalex and @paulRbr !
ChristopheDujarric
force-pushed
the
summary-to-description
branch
from
cd2eb64
to
0522091
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates
summaryfield names todescriptionin 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