Skip to content

Releases: cloud-annotations/docusaurus-openapi

v0.7.1

19 Dec 03:24
72a01f6
Compare
Choose a tag to compare

What's Changed

  • Docusaurus v3 support 🎉

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

Breaking Changes

Full Changelog: v0.6.4...v0.7.1

v0.6.4

15 Mar 18:17
0beb11b
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v0.6.3...v0.6.4

v0.6.3

14 Mar 23:50
e37b579
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v0.6.2...v0.6.3

v0.4.2

31 Dec 04:20
2439db3
Compare
Choose a tag to compare

0.4.2 (Dec 30, 2021)

Enhancements and bug fixes

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

v0.4.1

29 Dec 04:21
244cfca
Compare
Choose a tag to compare

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)

v0.4.0

23 Dec 21:07
ef53cfd
Compare
Choose a tag to compare

0.4.0 (Dec 23, 2021)

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

    // 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:

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

v0.3.1

23 Dec 20:28
3b2c776
Compare
Choose a tag to compare

0.3.1 (Dec 21, 2021)

High level enhancements

  • Added support for more schema qualifiers:

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

    Example:

    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)

v0.3.0

16 Dec 16:17
378bcd7
Compare
Choose a tag to compare

0.3.0 (Dec 16, 2021)

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 info stanza will now generate an "Introduction" page

    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

    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)

v0.2.3

11 Dec 19:59
6a14067
Compare
Choose a tag to compare

0.2.3 (Dec 11, 2021)

Enhancements and bug fixes

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

v0.2.2

06 Dec 07:35
368776a
Compare
Choose a tag to compare

0.2.2 (Dec 6, 2021)

Fix broken package