docusaurus-openapi-docs
docusaurus-openapi-docs copied to clipboard
🦝 OpenAPI plugin for generating API reference docs in Docusaurus v2.
## Describe the bug Building the Template Repository project throws useScrollController called outside of ScrollControllerProvider ## Expected behavior The Template Repository should be built without a problem. ## Current behavior...
### 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,...
## Documentation link https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/db293ef23fc637ab83948e4183028cbae5bc211b/README.md?plain=1#L180 ## Describe the problem The documentation indicates `categoryLinkSource` supports a `none` option, however, the plugin only accepts `[tag, info, auto]` `[ValidationError]: "config.api.sidebarOptions.categoryLinkSource" must be one of...
### Is your feature request related to a problem? My API contains custom vendor extensions so it does certain actions as part of the build. The plugin should ignore or...
## Documentation link It doesn't exist yet. ## Describe the problem If I swizzle a component, e.g. `ApiExplorer/index.tsx`, my TypeScript configuration will start complaining with errors such as this: ```...
## Describe the bug If my configured versions in the `docusaurus-plugin-openapi-docs` plugin instance specify an `outputDir` that does not contain the `path` value from the `@docusaurus/plugin-content-docs` plugin instance, then `gen-api-docs:version`...
Greeting! I would like to render the 'openapi-sidebar-default' sidebar menu on a custom page. But I am unable to import the apiMetadata on a custom page. Any help would be...
Problem with Generating Swagger Files There is an issue when generating Swagger files that use schemas referenced by other YAML files. This problem leads to compilation errors during project build...
## Describe the bug The generated code in curl, Python, etc. is not well generated when we have query parameters with a list of values. The query parameters in the...
## Describe the bug When rendering a DocCard, the frontmatter description is used - https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-classic/src/theme/DocCard/index.tsx#L80-L86 This plugin currently puts markdown into the frontmatter, the DocCard component does not transform markdown...