Data

Tools

Indexes

Applications

Experiments

Open Source Science

Recent Releases of https://github.com/cloud-annotations/docusaurus-openapi

https://github.com/cloud-annotations/docusaurus-openapi - v0.7.1

What's Changed

  • Docusaurus v3 support 🎉

Big thanks to @sean-perkins, @techwritermat and @andremartinssw for their efforts!

Breaking Changes

  • From v0.7.0 onward, this plugin will only be compatible with Docusaurus v3.
  • Due to the use of MDXv3 there are several markdown related breaking changes. See https://docusaurus.io/docs/migration/v3#common-mdx-problems for more info.

Full Changelog: https://github.com/cloud-annotations/docusaurus-openapi/compare/v0.6.4...v0.7.1

- TypeScript
Published by bourdakos1 over 2 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.6.4

What's Changed

  • docs: update template version by @yzhe819 in https://github.com/cloud-annotations/docusaurus-openapi/pull/225
  • Add existing site install instructions by @baptisteArno in https://github.com/cloud-annotations/docusaurus-openapi/pull/229
  • Fix invalid ignore pattern for underscore files by @baptisteArno in https://github.com/cloud-annotations/docusaurus-openapi/pull/233
  • Hide required labels on response schemas by @baptisteArno in https://github.com/cloud-annotations/docusaurus-openapi/pull/230
  • Ensure path-level parameters are passed to the theme by @danieleds in https://github.com/cloud-annotations/docusaurus-openapi/pull/235
  • Convert some relative imports in theme package by @chris48s in https://github.com/cloud-annotations/docusaurus-openapi/pull/237
  • Fixes and enhancements for array query param handling by @chris48s in https://github.com/cloud-annotations/docusaurus-openapi/pull/241
  • Prepare release v0.6.4 by @chris48s in https://github.com/cloud-annotations/docusaurus-openapi/pull/242

New Contributors

  • @baptisteArno made their first contribution in https://github.com/cloud-annotations/docusaurus-openapi/pull/229
  • @chris48s made their first contribution in https://github.com/cloud-annotations/docusaurus-openapi/pull/237

Full Changelog: https://github.com/cloud-annotations/docusaurus-openapi/compare/v0.6.3...v0.6.4

- TypeScript
Published by bourdakos1 about 3 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.6.3

What's Changed

  • Support for loading custom Markdown files by @danieleds in https://github.com/cloud-annotations/docusaurus-openapi/pull/193
  • Enable multiselect in form-urlencoded body by @danieleds in https://github.com/cloud-annotations/docusaurus-openapi/pull/220
  • fix: make sure to encode values in query and path parameters by @danieleds in https://github.com/cloud-annotations/docusaurus-openapi/pull/219
  • Fix spelling error in README by @ankitshubham97 in https://github.com/cloud-annotations/docusaurus-openapi/pull/221
  • fix: compatability with docusaurus 2.2.0 by @sean-perkins in https://github.com/cloud-annotations/docusaurus-openapi/pull/223
  • Prepare release v0.6.3 by @sean-perkins in https://github.com/cloud-annotations/docusaurus-openapi/pull/224

New Contributors

  • @ankitshubham97 made their first contribution in https://github.com/cloud-annotations/docusaurus-openapi/pull/221

Full Changelog: https://github.com/cloud-annotations/docusaurus-openapi/compare/v0.6.2...v0.6.3

- TypeScript
Published by bourdakos1 about 3 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.4.2

0.4.2 (Dec 30, 2021)

Enhancements and bug fixes

  • Update package metadata (#131)
  • Fix mobile css bug (#129)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.4.1

0.4.1 (Dec 28, 2021)

Enhancements and bug fixes

  • Add create command (#126)
  • Update demo (#124)
  • Update README.md (#123)
  • Add README badges (#122)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.4.0

0.4.0 (Dec 23, 2021)

High level enhancements

  • Docusaurus beta.14 support

js // 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 our docusaurus-plugin-proxy plugin.

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/users will now proxy the request to http://localhost:3001/api/users:

```js // docusaurus.config.js

const config = { plugins: [["docusaurus-plugin-proxy", { "/api": "http://localhost:3001" }]], // ... }; ```

To proxy /api/users to http://localhost:3001/users, the path can be rewritten:

```js // 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

  • Bump to beta 14 and fix proxy plugin (#120)
  • Fix dependency resolutions (#119)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.3.1

0.3.1 (Dec 21, 2021)

High level enhancements

  • Added support for more schema qualifiers:

- maxLength - minLength - maximum - minumum - exclusiveMaximum - exclusiveMinimum - pattern

Example:

yaml slug: type: string description: The human-readable, unique identifier, used to identify the document. minLength: 1 maxLength: 40 pattern: "^[a-zA-Z0-9_-]*$"

Displays:

slug string

Possible 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)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.3.0

0.3.0 (Dec 16, 2021)

High level enhancements

  • Docusaurus beta.13 support (Thanks @Josh-Cena!)

js // Be sure to update @docusaurus/core: "dependencies": { "@docusaurus/core": "2.0.0-beta.13", // ... }

  • The OpenAPI info stanza will now generate an "Introduction" page

yaml openapi: 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 allOf keywords

yaml requestBody: 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

    status string

    Enum: "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 allOf JSON schema support (#96)
    • Display enum values in tables (#93)
    • Initial plugin refactor (#86)
    • Upgrade to Docusaurus beta.13 (#88)

    - TypeScript
    Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.2.3

0.2.3 (Dec 11, 2021)

Enhancements and bug fixes

  • Add case-insensitive security scheme support (#83)
  • Add CodeSandbox CI (#77)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.2.2

0.2.2 (Dec 6, 2021)

Fix broken package

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.2.1

0.2.1 (Dec 5, 2021)

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 authPersistence option to themeConfig.api. Defaults to "localStorage", can be set to false to disable or sessionStorage to only persist while the window is open.

Other enhancements and bug fixes

  • Add better auth support (#74)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.2.0

0.2.0 (Dec 4, 2021)

💥 Breaking Changes

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-api
  • docusaurus-plugin-api
  • docusaurus-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:

```diff // 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)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.1.1

0.1.1 (Nov 24, 2021)

Enhancements and bug fixes

  • Fix missing status code description (#61)
  • Fix narrow tables style regression (#55)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.1.0

0.1.0 (Nov 4, 2021)

Enhancements and bug fixes

  • Update project structure (#52)
  • Update plugin to support Docusaurus 2.0.0 beta (#51)

- TypeScript
Published by bourdakos1 over 4 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.0.16

- TypeScript
Published by bourdakos1 about 5 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.0.15

- TypeScript
Published by bourdakos1 about 5 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.0.14

- TypeScript
Published by bourdakos1 about 5 years ago

https://github.com/cloud-annotations/docusaurus-openapi - v0.0.13

- TypeScript
Published by bourdakos1 about 5 years ago