Enhancements and bug fixes
- Remove axios dependency (#288)
Bug Fixes for Docusaurus 3.2.0 upgrade (#283)
addLeadingSlashandaddTrailingSlashare now imported from@docusaurus/utils-common- Omit
showLastUpdateAuthorandshowLastUpdateTimefrom PluginOptions - Updated
toNavfunction to handlenav.menuitems that now have a role ofbuttoninstead oflink - Updated Docusaurus version to 3.2.0
Enhancements and bug fixes
- Use parseMarkdownFile instead of parseMarkdownString (#277)
Enhancements and bug fixes
- Fix bash syntax highlighting (#274)
High-level enhancements
- Bug fixes related to Docusaurus v3 migration
Other enhancements and bug fixes
High-level enhancements
- Docusaurus v3 support (#266)
- Allow pressing enter to perform the 'Execute' action (#255)
- Render examples in a
<code>block (#256)
Other enhancements and bug fixes
- Wrap code examples tabs in narrow browser windows (#250)
- Add border to form inputs when using light theme (#252)
- Fix: Page crash on half surrogate pair (#261)
High-level enhancements
- Fixes and enhancements for array query param handling (#241)
- Respect the
maxItemsproperty for array query params - Add compatibility for
styleandexplodeproperties when rendering array query params - Fix infinite render loop on pages using array query params
- Respect the
Other enhancements and bug fixes
- Convert some relative imports in theme package (#237)
- Ensure path-level parameters are passed to the theme (#235)
- Hide required labels on response schemas (#230)
- Fix invalid ignore pattern for underscore files (#233)
- Add existing site install instructions (#229)
- Docs: update template version (#225)
High-level enhancements
Other enhancements and bug fixes
High-level enhancements
- Authorize with api keys in header
Other enhancements and bug fixes
- feat(auth): authorize with api keys in header (#208)
- add example key serverVariablesPersistance in demo (#204)
Other enhancements and bug fixes
- Persist server variables configuration (#202)
- fix(theme): new location for theme icons (#203)
- Fix: loading failed for local openapi json file on Windows (#197)
- ensure description from schema is not ignored (#194)
- Fix illegal color value bug (#196)
- chore: update template version (#195)
- Escape html in parameter names (#189)
- Category squashing (#188)
High-level enhancements
- Compatibility with Docusaurus 2.0.0-beta.21
Other enhancements and bug fixes
- Compatibility with Docusaurus 2.0.0-beta.21 (#185)
- Resolve
allOfreferences (#184) - Fetch openapi from a URL (#173)
- Fix Cypress test (#157)
- Add display name extension for tags (#154)
High-level enhancements
- All theme components are now TypeScript 🎉
Other enhancements and bug fixes
- Fix small theme regression (#151)
- Clear request body when empty (#147)
- Fix code editor background color bug (#146)
- Update theme components to TypeScript (#130)
Enhancements and bug fixes
Enhancements and bug fixes
High-level enhancements
-
Docusaurus beta.14 support
// Be sure to update @docusaurus/core: "dependencies": { "@docusaurus/core": "2.0.0-beta.14", // ... }
-
With the release of Docusaurus beta.14 (Thanks @slorber!), we can now support configuration of
webpack-dev-server's proxy via ourdocusaurus-plugin-proxyplugin.This can be useful when you have a separate API backend development server and you want to send API requests on the same domain.
With the following, a request to
/api/userswill now proxy the request tohttp://localhost:3001/api/users:// docusaurus.config.js const config = { plugins: [["docusaurus-plugin-proxy", { "/api": "http://localhost:3001" }]], // ... };
To proxy
/api/userstohttp://localhost:3001/users, the path can be rewritten:// docusaurus.config.js const config = { plugins: [ [ "docusaurus-plugin-proxy", { "/api": { target: "http://localhost:3001", pathRewrite: { "^/api": "" }, }, }, ], ], // ... };
For more config options, see devServer.proxy.
-
Better yarn 3 support
Other enhancements and bug fixes
High-level enhancements
-
Added support for more schema qualifiers:
- maxLength - minLength - maximum - minumum - exclusiveMaximum - exclusiveMinimum - patternExample:
slug: type: string description: The human-readable, unique identifier, used to identify the document. minLength: 1 maxLength: 40 pattern: "^[a-zA-Z0-9_-]*$"
Displays:
slugstringPossible values: 1 ≤ length ≤ 40, Value must match regular expression
^[a-zA-Z0-9_-]*$The human-readable, unique identifier, used to identify the document.
Other enhancements and bug fixes
- Add additional schema qualifiers (#112)
- Sidebar generation refactor (#111)
- Add recursive folder structure reading & labeling support (#107)
- Add experimental support for loading a multiple OpenAPI definitions (#103)
- Add sidebar item classname for method (#104)
- Fix schema name bug with allOf (#102)
High-level enhancements
-
Docusaurus beta.13 support (Thanks @Josh-Cena!)
// Be sure to update @docusaurus/core: "dependencies": { "@docusaurus/core": "2.0.0-beta.13", // ... }
-
The OpenAPI
infostanza will now generate an "Introduction" pageopenapi: 3.0.3 info: title: Swagger Petstore version: 1.0.0 description: | This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.
-
Request bodies will now render JSON Schema with the use of
allOfkeywordsrequestBody: content: description: Example request application/json: schema: allOf: - $ref: "#/components/schema/Example1" - $ref: "#/components/schema/Example2"
-
Enum options will now be displayed in schema tables
statusstringEnum:
"available","pending","sold"Pet status in the store
Other enhancements and bug fixes
- Initial proxy code (#97)
- Add support for an introduction page (#94)
- Add
allOfJSON schema support (#96) - Display enum values in tables (#93)
- Initial plugin refactor (#86)
- Upgrade to Docusaurus beta.13 (#88)
Enhancements and bug fixes
Fix broken package
High-level enhancements
- The demo panel now allows you to choose the security scheme from a dropdown that is populated by the OpenAPI definition (only showing the dropdown if more than one is listed)
- Adds support for using multiple auth modes simultaneously (Eg:
(BearerAuth) OR (ApiKeyAuth AND BasicAuth)) - Adds an
authPersistenceoption tothemeConfig.api. Defaults to"localStorage", can be set tofalseto disable orsessionStorageto only persist while the window is open.
Other enhancements and bug fixes
- Add better auth support (#74)
The plugin option openapiPath has been renamed to path and no longer needs to be wrapped in require.resolve.
As recomended my the Docusaurus documentation, the plugin docusaurus-plugin-api has been properly split into 3 packages:
docusaurus-preset-apidocusaurus-plugin-apidocusaurus-theme-api
The package docusaurus-plugin-api will no longer work on it's own without docusaurus-theme-api. Instead, the preset docusaurus-preset-api can be used on it's own and act as a drop-in replacement for @docusaurus/preset-classic.
Example usage:
// docusaurus.config.js
const config = {
- plugins: [
- [
- "docusaurus-plugin-openapi",
- {
- openapiPath: require.resolve("./examples/openapi.json"),
- },
- ],
- ],
presets: [
[
- "@docusaurus/preset-classic",
+ "docusaurus-preset-openapi",
{
+ api: {
+ path: "examples/openapi.json",
+ }
docs: {
// doc options ...
},
blog: {
// blog options ...
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
}Other enhancements and bug fixes
- Fix multi plugin bug (#69)
- Add yaml support (#68)
- Generate markdown for full page (#65)
- Refactor plugin into separate packages (#64)
- Update documentation (#63)
Enhancements and bug fixes
Enhancements and bug fixes