openai-openapi icon indicating copy to clipboard operation
openai-openapi copied to clipboard

Update summary field name to description in info objects

Open ChristopheDujarric opened this issue 1 year ago • 3 comments

This PR updates summary field names to description in info objects.

The OpenAPI specification indeed specifies:

Field Name Type Description
summary string A short summary of the API.
description string A description of the API. CommonMark syntax MAY be used for rich text representation.

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

ChristopheDujarric avatar Jun 06 '24 09:06 ChristopheDujarric

@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.

benadamdev avatar Jun 06 '24 16:06 benadamdev

@ChristopheDujarric I've sent you a PR to your branch with another commit renaming the existing Operation#x-oaiMeta.name properties to the OpenAPI specified Operation#summary which will help to have some better titles in your generated documentation :)

paulRbr avatar Jun 06 '24 18:06 paulRbr

Thanks @paulRbr !

ChristopheDujarric avatar Jun 06 '24 18:06 ChristopheDujarric