docusaurus-openapi-docs icon indicating copy to clipboard operation
docusaurus-openapi-docs copied to clipboard

Support showing openapi Links

Open aszenz opened this issue 1 year ago • 0 comments

Is your feature request related to a problem?

When the api response is returning an identifier for a field and it is linked to another operation in the schema, I want to show that clearly so that the api users can understand that they can use this response info to fetch more information by calling related/linked operations.

See the open api link specification:

https://spec.openapis.org/oas/latest.html#link-object

And the swaager docs:

https://swagger.io/docs/specification/links/

Describe the solution you'd like

Initially just show the links like swagger docs does:

Screenshot from 2024-08-28 14-17-20

Later somehow use links to allow staging another operation.

Describe alternatives you've considered

  • Provide sub resources directly as nested objects

Additional context

I'm trying to make it easy to explain to users that they can fetch nested information by making another request to fetch sub resources.

aszenz avatar Aug 28 '24 12:08 aszenz