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

Schemas sections like in the default swagger UI

Open etiennea opened this issue 2 years ago • 2 comments

Is your feature request related to a problem?

This is really missing, Schemas reference. Ideally with the ability to filter. We use nestjs and so we have both Entities and DTO schemas. Would be a great addition.

Describe the solution you'd like

A new sidebar menu with the list of Schemas so one can jump in them directly. An option to enable/disable this. An option to filter these for example only those containing "Entity" The rendering of the Schemas is already supported in the endpoints so this should not be too complex to do.

Describe alternatives you've considered

No good alternatives

Additional context

Requested by my product team for our docs, to better keep track of our domain.

etiennea avatar Jun 20 '23 17:06 etiennea

Hi @etiennea, this is one of the more requested features we've seen so far. That said, since our plugin already attempts to fully resolve operation request/response schemas, I wonder how valuable this feature could actually be? Are there schemas not referenced by endpoints that you would also want to document?

sserrata avatar Jun 27 '23 17:06 sserrata

Hi @sserrata, it would help us in several ways:

  • Have extra schemas, like our entities. Our DTO are not always 100% our entities.
  • Have all the schemas in one place is easier for our product team, when talking about the domain

etiennea avatar Jun 28 '23 21:06 etiennea

already addressed

sserrata avatar Jun 28 '24 20:06 sserrata