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

[FR] Improve support for micro-specs #95

Closed
sserrata opened this issue May 19, 2022 · 1 comment
Closed

[FR] Improve support for micro-specs #95

sserrata opened this issue May 19, 2022 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@sserrata
Copy link
Member

Is your feature request related to a problem?

In some cases, OpenAPI docs may be split into multiple micro-specs that, collectively, represent a single, logical API. In those cases, each micro-spec will come with its own info section which will also generate a index.api.mdx. When grouping paths by tag, this can lead to filename collisions as each subsequent index.api.mdx file that is generated will overwrite the one prior.

Describe the solution you'd like

The idea would be to extend support for the micro-spec use case by providing an option for defining when multiple specs should be treated as micro-specs and for creating a convention for generating unique "introduction" docs for each tagged group of paths. Additionally, sidebarOptions should be extended to support setting the category link as the "introduction" doc for each respective group.

Describe alternatives you've considered

  • Merging micro-specs into a mono-spec.
  • Manually creating the sidebar

Additional context

Longer term, it probably makes more sense to transition micro-specs into a mono-spec but there are some cases where this isn't possible or readily feasible.

@sserrata
Copy link
Member Author

#100

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