Skip to content
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

Support showing openapi Links #938

Open
aszenz opened this issue Aug 28, 2024 · 0 comments
Open

Support showing openapi Links #938

aszenz opened this issue Aug 28, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@aszenz
Copy link

aszenz commented Aug 28, 2024

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 aszenz added the enhancement New feature or request label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant