Merge tag 'refs/tags/v2.0.0' into sections-at-the-end

2025-08-01 19:00:21 +03:00 · 2022-10-12 17:23:33 +02:00 · 2022-10-12 17:23:33 +02:00 · 9463e4cd50
commit 9463e4cd50
parent 76af74e391 5fb4daa618
19 changed files with 4526 additions and 90 deletions
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@ -14,7 +14,7 @@ Hi! We're really excited that you are interested in contributing to ReDoc. Befor
 ## Pull Request Guidelines
 Before submitting a pull request, please make sure the following is done:

-1. Fork the repository and create your branch from master.
+1. Fork the repository and create your branch from main.
 2. Run `npm install` in the repository root.
 3. If you’ve fixed a bug or added code that should be tested, add tests!
 4. Ensure the test suite passes (`npm test`). Tip: `npm test -- --watch TestName` is helpful in development.
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -2,7 +2,7 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: 'type: bug'
+labels: 'Type: Bug'
 assignees: ''

 ---
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'Type: Enhancement'
 assignees: ''

 ---
@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
 A clear and concise description of any alternative solutions or features you've considered.

 **Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@ -3,46 +3,46 @@ on:
  release:
    types: [published]
 jobs:
-  push_to_registry:
-    name: Push Docker image to GitHub Packages
-    runs-on: ubuntu-latest
-    permissions:
-      packages: write
-      contents: read
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v3
-      - name: Login to GitHub Container Registry
-        uses: docker/login-action@v1
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      - name: Prepare
-        id: prep
-        run: |
-          DOCKER_IMAGE=ghcr.io/redocly/redoc/cli
-          VERSION=edge
-          if [[ $GITHUB_REF == refs/tags/* ]]; then
-            VERSION=${GITHUB_REF#refs/tags/}
-          elif [[ $GITHUB_REF == refs/heads/* ]]; then
-            VERSION=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's#/+#-#g')
-          elif [[ $GITHUB_REF == refs/pull/* ]]; then
-            VERSION=pr-${{ github.event.number }}
-          fi
-          TAGS="${DOCKER_IMAGE}:${VERSION},${DOCKER_IMAGE}:latest"
-          if [ "${{ github.event_name }}" = "push" ]; then
-            TAGS="$TAGS,${DOCKER_IMAGE}:sha-${GITHUB_SHA::8}"
-          fi
-          echo ::set-output name=version::${VERSION}
-          echo ::set-output name=tags::${TAGS}
-          echo ::set-output name=created::$(date -u +'%Y-%m-%dT%H:%M:%SZ')
-      - name: Push to GitHub Packages
-        uses: docker/build-push-action@v3
-        with:
-          context: ./cli
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.prep.outputs.tags }}
+  # push_to_registry:
+  #   name: Push Docker image to GitHub Packages
+  #   runs-on: ubuntu-latest
+  #   permissions:
+  #     packages: write
+  #     contents: read
+  #   steps:
+  #     - name: Check out the repo
+  #       uses: actions/checkout@v3
+  #     - name: Login to GitHub Container Registry
+  #       uses: docker/login-action@v1
+  #       with:
+  #         registry: ghcr.io
+  #         username: ${{ github.repository_owner }}
+  #         password: ${{ secrets.GITHUB_TOKEN }}
+  #     - name: Prepare
+  #       id: prep
+  #       run: |
+  #         DOCKER_IMAGE=ghcr.io/redocly/redoc/cli
+  #         VERSION=edge
+  #         if [[ $GITHUB_REF == refs/tags/* ]]; then
+  #           VERSION=${GITHUB_REF#refs/tags/}
+  #         elif [[ $GITHUB_REF == refs/heads/* ]]; then
+  #           VERSION=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's#/+#-#g')
+  #         elif [[ $GITHUB_REF == refs/pull/* ]]; then
+  #           VERSION=pr-${{ github.event.number }}
+  #         fi
+  #         TAGS="${DOCKER_IMAGE}:${VERSION},${DOCKER_IMAGE}:latest"
+  #         if [ "${{ github.event_name }}" = "push" ]; then
+  #           TAGS="$TAGS,${DOCKER_IMAGE}:sha-${GITHUB_SHA::8}"
+  #         fi
+  #         echo ::set-output name=version::${VERSION}
+  #         echo ::set-output name=tags::${TAGS}
+  #         echo ::set-output name=created::$(date -u +'%Y-%m-%dT%H:%M:%SZ')
+  #     - name: Push to GitHub Packages
+  #       uses: docker/build-push-action@v3
+  #       with:
+  #         context: ./cli
+  #         push: ${{ github.event_name != 'pull_request' }}
+  #         tags: ${{ steps.prep.outputs.tags }}
  dockerhub:
    name: Publish redoc image to DockerHub
    runs-on: ubuntu-latest
--- a/.github/workflows/publish-cli.yml
+++ b/.github/workflows/publish-cli.yml
@ -3,7 +3,7 @@ name: Publish cli
 on:
  push:
    branches:
-      - master
+      - main

 jobs:
  bundle:
--- a/.github/workflows/sync.yml
+++ b/.github/workflows/sync.yml
@ -2,7 +2,7 @@ name: Sync Files
 on:
  push:
    branches:
-      - master
+      - main
  workflow_dispatch:
 jobs:
  sync:
@ -11,7 +11,7 @@ jobs:
      - name: Checkout Repository
        uses: actions/checkout@v3
      - name: Run GitHub File Sync
-        uses: Redocly/repo-file-sync-action@master
+        uses: Redocly/repo-file-sync-action@main
        with:
          GH_PAT: ${{ secrets.GH_PAT }}
          COMMIT_PREFIX: 'sync:'
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,3 +1,7 @@
+# [2.0.0](https://github.com/Redocly/redoc/compare/v2.0.0-rc.77...v2.0.0) (2022-09-12)
+
+
+
 # [2.0.0-rc.77](https://github.com/Redocly/redoc/compare/v2.0.0-rc.76...v2.0.0-rc.77) (2022-09-06)


--- a/README.md
+++ b/README.md
@ -1,9 +1,9 @@
 <div align="center">
-  <img alt="Redoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/master//docs/images/redoc.png" width="400px" />
+  <img alt="Redoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/main//docs/images/redoc.png" width="400px" />

  # Generate interactive API documentation from OpenAPI definitions

-  [![Build Status](https://travis-ci.com/Redocly/redoc.svg?branch=master)](https://travis-ci.com/Redocly/redoc) [![Coverage Status](https://coveralls.io/repos/Redocly/redoc/badge.svg?branch=master&service=github)](https://coveralls.io/github/Redocly/redoc?branch=master) [![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/master/LICENSE)
+  [![Coverage Status](https://coveralls.io/repos/Redocly/redoc/badge.svg?branch=main&service=github)](https://coveralls.io/github/Redocly/redoc?branch=main) [![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/main/LICENSE)

  [![bundle size](http://img.badgesize.io/https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js?compression=gzip&max=300000)](https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js) [![npm](https://img.shields.io/npm/dm/redoc.svg)](https://www.npmjs.com/package/redoc) [![](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc) [![Docker Build Status](https://img.shields.io/docker/build/redocly/redoc.svg)](https://hub.docker.com/r/redocly/redoc/)
 </div>
@ -21,7 +21,7 @@ By default Redoc offers a three-panel, responsive layout:
 - The central panel contains the documentation.
 - The right panel contains request and response examples.

-![Redoc demo](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png)
+![Redoc demo](https://raw.githubusercontent.com/Redocly/redoc/main/demo/redoc-demo.png)

 ## Live demo

--- a/cli/README.md
+++ b/cli/README.md
@ -26,7 +26,7 @@ Some examples:
 - Serve with the `nativeScrollbars` option set to true:<br/>
  `$ redoc-cli serve [spec] --options.nativeScrollbars`
 - Bundle using a custom [Handlebars](https://handlebarsjs.com/) template
-  (check the [default template](https://github.com/Redocly/redoc/blob/master/cli/template.hbs) for an example):<br/>
+  (check the [default template](https://github.com/Redocly/redoc/blob/main/cli/template.hbs) for an example):<br/>
  `$ redoc-cli build [spec] -t custom.hbs`
 - Bundle using a custom template and add custom `templateOptions`:<br/>
  `$ redoc-cli build [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"`
--- a/cli/npm-shrinkwrap.json
+++ b/cli/npm-shrinkwrap.json
--- a/cli/package.json
+++ b/cli/package.json
@ -1,6 +1,6 @@
 {
  "name": "redoc-cli",
-  "version": "0.13.19",
+  "version": "0.13.20",
  "description": "ReDoc's Command Line Interface",
  "main": "index.js",
  "bin": "index.js",
@ -19,7 +19,7 @@
    "node-libs-browser": "^2.2.1",
    "react": "^17.0.1",
    "react-dom": "^17.0.1",
-    "redoc": "2.0.0-rc.76",
+    "redoc": "2.0.0-rc.77",
    "styled-components": "^5.3.0",
    "update-notifier": "^5.0.1",
    "yargs": "^17.3.1"
--- a/demo/index.tsx
+++ b/demo/index.tsx
@ -21,7 +21,7 @@ const demos = [
 ];

 class DemoApp extends React.Component<
-  {},
+  Record<string, unknown>,
  { spec: object | undefined; specUrl: string; dropdownOpen: boolean; cors: boolean }
 > {
  constructor(props) {
@ -94,7 +94,7 @@ class DemoApp extends React.Component<
        <Heading>
          <a href=".">
            <Logo
-              src="https://github.com/Redocly/redoc/raw/master/docs/images/redoc-logo.png"
+              src="https://github.com/Redocly/redoc/raw/main/docs/images/redoc-logo.png"
              alt="Redoc logo"
            />
          </a>
--- a/demo/openapi-3-1.yaml
+++ b/demo/openapi-3-1.yaml
@ -16,14 +16,14 @@ info:
    [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
    It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
    tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

    # OpenAPI Specification
    This API is documented in **OpenAPI format** and is based on
    [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
    It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
    tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

    # Cross-Origin Resource Sharing
    This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).
--- a/demo/openapi.yaml
+++ b/demo/openapi.yaml
@ -16,14 +16,14 @@ info:
    [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
    It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
    tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

    # OpenAPI Specification
    This API is documented in **OpenAPI format** and is based on
    [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
    It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
    tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

    # Cross-Origin Resource Sharing
    This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).
--- a/demo/swagger.yaml
+++ b/demo/swagger.yaml
@ -15,13 +15,13 @@ info:
    [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
    It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
    tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).
    # OpenAPI Specification
    This API is documented in **OpenAPI format** and is based on
    [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
    It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
    tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+    OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).
    # Cross-Origin Resource Sharing
    This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).
    And that allows cross-domain communication from the browser.
--- a/docs/deployment/docker.md
+++ b/docs/deployment/docker.md
@ -37,5 +37,5 @@ docker run -p 8080:80 -e SPEC_URL=https://api.example.com/openapi.json redocly/r
 ## Create a Dockerfile

 You can also create a Dockerfile with some predefined environment variables. Check out
-a sample [Dockerfile](https://github.com/Redocly/redoc/blob/master/config/docker/Dockerfile)
+a sample [Dockerfile](https://github.com/Redocly/redoc/blob/main/config/docker/Dockerfile)
 in our code repo.
--- a/package-lock.json
+++ b/package-lock.json
@ -1,12 +1,12 @@
 {
  "name": "redoc",
-  "version": "2.0.0-rc.77",
+  "version": "2.0.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "redoc",
-      "version": "2.0.0-rc.77",
+      "version": "2.0.0",
      "license": "MIT",
      "dependencies": {
        "@redocly/openapi-core": "^1.0.0-beta.104",
@ -8765,7 +8765,7 @@
    "node_modules/get-pkg-repo/node_modules/meow": {
      "version": "3.7.0",
      "resolved": "https://registry.npmjs.org/meow/-/meow-3.7.0.tgz",
-      "integrity": "sha1-cstmi0JSKCkKu/qFaJJYcwioAfs=",
+      "integrity": "sha512-TNdwZs0skRlpPpCUK25StC4VH+tP5GgeY1HQOOGP+lQ2xtdkN2VtT/5tiX9k3IWpkBPV9b3LsAWXn4GGi/PrSA==",
      "dev": true,
      "dependencies": {
        "camelcase-keys": "^2.0.0",
@ -25906,7 +25906,7 @@
        "meow": {
          "version": "3.7.0",
          "resolved": "https://registry.npmjs.org/meow/-/meow-3.7.0.tgz",
-          "integrity": "sha1-cstmi0JSKCkKu/qFaJJYcwioAfs=",
+          "integrity": "sha512-TNdwZs0skRlpPpCUK25StC4VH+tP5GgeY1HQOOGP+lQ2xtdkN2VtT/5tiX9k3IWpkBPV9b3LsAWXn4GGi/PrSA==",
          "dev": true,
          "requires": {
            "camelcase-keys": "^2.0.0",
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
  "name": "redoc",
-  "version": "2.0.0-rc.77",
+  "version": "2.0.0",
  "description": "ReDoc",
  "repository": {
    "type": "git",
--- a/src/utils/tests/snapshots/loadAndBundleSpec.test.ts.snap
+++ b/src/utils/tests/snapshots/loadAndBundleSpec.test.ts.snap
@ -491,14 +491,14 @@ This API is documented in **OpenAPI format** and is based on
 [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
 It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
 tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

 # OpenAPI Specification
 This API is documented in **OpenAPI format** and is based on
 [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
 It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
 tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

 # Cross-Origin Resource Sharing
 This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).
@ -2440,14 +2440,14 @@ This API is documented in **OpenAPI format** and is based on
 [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
 It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
 tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

 # OpenAPI Specification
 This API is documented in **OpenAPI format** and is based on
 [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
 It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
 tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).

 # Cross-Origin Resource Sharing
 This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).
@ -4224,13 +4224,13 @@ This API is documented in **OpenAPI format** and is based on
 [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
 It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
 tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).
 # OpenAPI Specification
 This API is documented in **OpenAPI format** and is based on
 [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.
 It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)
 tool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard
-OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).
+OpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md).
 # Cross-Origin Resource Sharing
 This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).
 And that allows cross-domain communication from the browser.