Redoc update (#5)

* feat: add new option hideSchemaPattern (Redocly#1475)

* feat: add new option hideSchemaPattern
* chore: add hideSchemaPattern option to readme

* fix: add missed labels to elements (Redocly#1445)

* chore: upgrade prism.js

fixes Redocly#1455

* chore: Release 2.0.0-rc.48 🔖

* docs: fix `menuToggle` default value

fixes Redocly#1476

[ci skip]

* docs: fix the Rebilly link

* chore(cli): v0.10.2

* fix: fix SourceCodeWithCopy component to be non-pure

* docs: document theme options (Redocly#1438)

* chore: remove duplicate semicolons (Redocly#1504)

* fix: crash on multiple examples on parameter object

fixes Redocly#1485

* fix: pass boolean and number values as a string in highlight function (Redocly#1512)

* chore: Release 2.0.0-rc.49 🔖

* chore: update travis badge url

* fix: background-color in search results (Redocly#1531)

* fix: background-color in search results

* Delete some changes

* chore: clean up .travis.yaml

* chore(cli): upgrade redoc to rc.49

* chore(cli): v0.10.3

* fix: false-positive recursive tag case when using oneOf + allOf (Redocly#1534)

* fix: add includes polyfill

fixes Redocly#1530

* chore: Release 2.0.0-rc.50 🔖

* chore(cli): v0.10.4

* docs: remove outdated config option from readme (Redocly#1543)

* docs: minor syntax highlight fix on the README (Redocly#1549)

* feat: add disable-google-font parameter to serve command in cli (Redocly#1558)

* docs: remove extra word in grammar (Redocly#1539)

* chore: use openapi-core to bundle definition instead of json-schema-ref-parser (Redocly#1500)

* chore: use openapi-core to bundle definition instead of json-schema-ref-parser
* chore: update: root and demo webpack configs
* chore: refactor loadAndBundleSpec
* chore: update vesions: openapi-core, redoc
* chore: rolled back webpack.config(s) to previous version
* chore: changed the way of creating core Config for bundling definition
* fix: disable eslint react/display-name
* fix: update nodejs version to 12 in travis config
* chore: optimize verification: browser or server
* chore: add fetch only for browser
* Update src/utils/loadAndBundleSpec.ts
* chore: isBrowser verification improvment
Co-authored-by: Roman Hotsiy <[email protected]>

* chore: unit tests to check loading and bundling api definitions with openapi-core (Redocly#1568)

* chore: Release 2.0.0-rc.51

* chore(cli): v0.11.0

* chore(cli): v0.11.1

* fix: broken paths when budle or serve using cli (Redocly#1572)

* chore(cli): v0.11.2

* chore: update openapi-core version to fix parsing root document

* chore: Release 2.0.0-rc.52

* chore: Release 2.0.0-rc.53

* fix: added missing semicolon to styling (Redocly#1578)

* docs: update specUrl (Redocly#1577)

* chore(cli): v0.11.3

* fix: right absolute path for load and bundle definition (Redocly#1579)

* chore(cli): v0.11.4

* chore: update(cli) engine node version >=12 (Redocly#1583)

* fix: parse json theme string for standalone tag (Redocly#1492)

* fix: use operation path if operation summary/description is not provided (Redocly#1596)

resolves Redocly#1270

* feat: add basic support openApi 3.1 (Redocly#1622)

* chore: upgrade dependencies (Redocly#1634)

* chore: modernize build pipeline (Redocly#1635)

* chore: remove extra webpack resolver

* feat: merge refs oas 3.1 (Redocly#1640)

* chore: v2.0.0-rc.54

* chore(cli): upgrade redoc to rc.54

* chore(cli): v0.12.0

* chore(cli): v0.12.1

* feat: added git folder sync config

* chore: change cors url in the demo

* fix: broken linkify

fixes Redocly#1655

* fix: fix accidentally removed onLoaded

fixes Redocly#1656

* chore: fix sync workflow

* chore: v2.0.0-rc.55

* chore: fix demo slack url

* chore: changed docs sync flow

* chore: added security section into pull request template

* docs: improve the redoc cli README (Redocly#1679)

- Break some long lines
- Add some articles (the, a)
- Add a couple links for additional context
- Expand the SSR acronym
- Describe what --watch does

* feat: added localization for some labels (Redocly#1675)

* feat: add yaml highlight (Redocly#1684)

* feat: add yaml highlight

* chore: upgrade prism version

* chore(cli): v0.12.2

* chore: bumps npm-shrinkwrap (Redocly#1688)

* chore: upgrade shrinkwrap

* chore: fix dockerfile

* fix: handle empty object in security array (Redocly#1678)

* docs: add real-life usage example: BoxKnight (Redocly#1651)

* chore: add github template (Redocly#1708)

* chore: add headers to github templates (Redocly#1710)

* fix: improve openapi 3.1 (Redocly#1700)

* fix: hideLoading options in redoc standalone (Redocly#1709)

* feat: add github action to build docker images and push to ghcr.io on release (Redocly#1614)

* fix: nullable object's fields were missing (Redocly#1721)

* chore: up version for release (Redocly#1722)

* chore: add change log for v2.0.0-rc.56(Redocly#1723)

* chore(cli): v0.12.3

* docs(GSOD): Adds new quickstart doc (Redocly#1718)

* docs: fix broken links in intro (Redocly#1730)

* Removes content that is now in documentation and adds link to docs

* fix: Schema for events incorrectly omits readOnly and includes writeOnly (Redocly#1720 Redocly#1540)

* Apply suggestions from code review

* Update README.md

Co-authored-by: Adam Altman <[email protected]>

* Updates readme with about section and organizes features list

* Adds some notes to deployment

* feat: new option generatedPayloadSamplesMaxDepth (Redocly#1642)

* chore: update libs (Redocly#1707)

* fix: Redoc spelling

* Updates per reviews and adds new logo

* Minor edits

* fix: scrolling to the first item (Redocly#1753)

* Adds comparison table and OpenAPI link section

* Minor edit

* Updates image src

* fix: OpenAPI 3.1: Missing description when $ref used Redocly#1727

* fix: OpenAPI 3.1: Missing description when $ref used Redocly#1727

* fix: improve publish action scripts (Redocly#1729)

* feat: add q/kdb+ syntax highlighting (Redocly#1605)

* fix: The number of items in the array in the array is incorrect Redocly#1762 (Redocly#1763)

* fix: fix deref logic for oas3.1 (Redocly#1767)

* chore: remove commented out code (Redocly#1768)

* fix: No match scenario in search (Redocly#1667)

Co-authored-by: Alex Varchuk <[email protected]>

* chore: v2.0.0-rc.57 (Redocly#1770)

* chore: update publish cli workflow

* chore: fix publish workflow and disable s3 demo

* chore: fix publish workflow again

* chore(cli): v0.13.0 (Redocly#1771)

* chore: fix cli publish workflow

* fix: Default boolean property value not rendered Redocly#1779 (Redocly#1781)

* chore: remove broken badges from README

* [GSoD]Reorganizes the quickstart into a deployment guide and quickstart (Redocly#1749)

* Reorganizes the quickstart into a deployment guide and quickstart

* Minor edits

* fix: minor formatting issue

* fix: simplify phrasing

* Adds redirects, link to preview-docs docs, and other review edits

* remove IE polyfills as IE is no longer supported

Co-authored-by: Ivana Isadora Devcic <[email protected]>

* sync: Synced local 'docs/' with remote 'docs/redoc/'

* fix: mobile view in docker image (Redocly#1795)

* sync: Synced local 'docs/' with remote 'docs/redoc/'

* sync: Synced local 'docs/' with remote 'docs/redoc/'

* chore: run prettier & add husky pre-commit hook (Redocly#1800)

* fix: exclusiveMin/Max shows incorect range (Redocly#1799)

* fix: exclusiveMin/Max shows incorect range

* cover all number range cases & add unit tests

* add more tests

* fix maximum value

* simplify humanizeNumberRange function

* simplify exclusive checks

* Update src/utils/openapi.ts

Co-authored-by: Roman Hotsiy <[email protected]>

* update test coverage

* linting

* revert weird prettier changes

* add md files to prettier ignore

Co-authored-by: Roman Hotsiy <[email protected]>

* fix: add browser build for webpack 5 (Redocly#1796)

* chore: v2.0.0-rc.58 (Redocly#1808)

* chore(cli): v0.13.1 (Redocly#1809)

* fix this

Co-authored-by: Anna Stasiuk <[email protected]>
Co-authored-by: romanhotsiy <[email protected]>
Co-authored-by: jabba-jedi <[email protected]>
Co-authored-by: Karl Scheirer <[email protected]>
Co-authored-by: baijunyao <[email protected]>
Co-authored-by: Anton Kozachuk <[email protected]>
Co-authored-by: Oleksiy Kachynskyy <[email protected]>
Co-authored-by: 迷渡 <[email protected]>
Co-authored-by: Patrick Demers <[email protected]>
Co-authored-by: Kurt Furbush <[email protected]>
Co-authored-by: Andriy Leliv <[email protected]>
Co-authored-by: Olivier Beaulieu <[email protected]>
Co-authored-by: langhabel <[email protected]>
Co-authored-by: Yevhenii Hyzyla <[email protected]>
Co-authored-by: AlexVarchuk <[email protected]>
Co-authored-by: Ivan Shvets <[email protected]>
Co-authored-by: Ivan Shvets <[email protected]>
Co-authored-by: Roman <[email protected]>
Co-authored-by: Waldir Pimenta <[email protected]>
Co-authored-by: ILya Volchenkov <[email protected]>
Co-authored-by: Andrea Mugx <[email protected]>
Co-authored-by: Valdir Mendes <[email protected]>
Co-authored-by: Marius Butuc <[email protected]>
Co-authored-by: Roelof Kallenkoot <[email protected]>
Co-authored-by: Heather Cloward <[email protected]>
Co-authored-by: Adam Altman <[email protected]>
Co-authored-by: Andriy Zaleskyy <[email protected]>
Co-authored-by: Ivana Isadora Devcic <[email protected]>
Co-authored-by: Swapnil Ogale <[email protected]>
Co-authored-by: Adam Altman <[email protected]>
Co-authored-by: Mark Theisen <[email protected]>
Co-authored-by: Roman Marshevskyy <[email protected]>
Co-authored-by: kylenarocroc <[email protected]>
Co-authored-by: Gabriel Simon Gianotti <[email protected]>
Co-authored-by: raghavi92 <[email protected]>
Co-authored-by: redocly-bot <null>
Co-authored-by: Oprysk Vyacheslav <[email protected]>

Author: 34 people

.eslintrc.js

@@ -17,7 +17,6 @@ module.exports = {
       version: 'detect',
     },
   },
-  plugins: ['@typescript-eslint', 'import'],
   rules: {
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/explicit-module-boundary-types': 'off',

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'type: bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Minimal reproducible OpenAPI snippet(if possible)**
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the problem to be solved**
+A clear and concise description of what problem to be solved
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+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.

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+## What/Why/How?
+
+## Reference
+
+## Testing
+
+## Screenshots (optional)
+
+## Check yourself
+
+- [ ] Code is linted
+- [ ] Tested
+- [ ] All new/updated code is covered with tests

.github/sync.yml

@@ -0,0 +1,6 @@
+group:
+  - files:
+      - source: docs/
+        dest: docs/redoc
+    repos: |
+      Redocly/docs

.github/workflows/demo-deploy-s3.yml

@@ -0,0 +1,12 @@
+name: Tests e2e
+
+on: [push]
+
+jobs:
+  build-and-e2e:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - run: npm ci
+    - run: npm run bundle
+    - run: npm run e2e

.github/workflows/e2e-tests.yml

@@ -0,0 +1,45 @@
+name: Publish Docker image
+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@v2
+      - 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}"
+          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@v2
+        with:
+          context: ./cli
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.prep.outputs.tags }}

.github/workflows/main.yml

@@ -0,0 +1,121 @@
+name: Publish cli
+
+on:
+  push:
+    branches:
+      - master
+
+
+jobs:
+  bundle:
+    needs: [ check-version-cli ]
+    if: needs.check-version-cli.outputs.changed == 'true'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v2
+    - name: Cache node modules
+      uses: actions/cache@v2
+      with:
+        path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+        key: npm-${{ hashFiles('package-lock.json') }}
+        restore-keys: |
+          npm-${{ hashFiles('package-lock.json') }}
+          npm-
+    - run: npm ci
+    - run: npm run bundle
+    - name: Store bundle artifact
+      uses: actions/upload-artifact@v2
+      with:
+        name: bundles-cli
+        path: bundles
+        retention-days: 1
+  unit-tests:
+    needs: [ check-version-cli ]
+    if: needs.check-version-cli.outputs.changed == 'true'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - run: npm ci
+    - run: npm test
+  e2e-tests:
+    needs: [ bundle ]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - run: npm ci
+    - name: Download bundled artifact
+      uses: actions/download-artifact@v2
+      with:
+        name: bundles-cli
+        path: bundles
+    - run: npm run e2e
+  bundle-cli:
+    needs: [ check-version-cli ]
+    if: needs.check-version-cli.outputs.changed == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - name: Cache node modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            npm-${{ hashFiles('package-lock.json') }}
+            npm-
+      - name: Install dependencies
+        run: npm ci
+      - name: Bundle
+        run: npm run compile:cli
+      - name: Store bundle artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: cli
+          path: cli
+          retention-days: 1
+  check-version-cli:
+    name: Check Version
+    runs-on: ubuntu-latest
+    outputs:
+      changed: ${{ steps.check.outputs.changed }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+      - name: Check if version has been updated
+        id: check
+        uses: EndBug/[email protected]
+        with:
+          file-name: ./cli/package.json
+          file-url: https://unpkg.com/redoc-cli/package.json
+          static-checking: localIsNew
+  publish-cli:
+    needs: [bundle-cli, unit-tests, e2e-tests]
+    if: needs.check-version-cli.outputs.changed == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "14.x"
+          registry-url: 'https://registry.npmjs.org'
+      - uses: actions/checkout@v2
+      - name: Download cli bundled artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: cli
+          path: cli
+      - name: Cache node modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+          key: npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            npm-${{ hashFiles('package-lock.json') }}
+            npm-
+      - name: Publish to NPM
+        run: cd cli/ && npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish-cli.yml

@@ -0,0 +1,100 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - v[0-9]*.[0-9]*.[0-9]*
+
+jobs:
+  bundle:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v2
+    - name: Cache node modules
+      uses: actions/cache@v2
+      with:
+        path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+        key: npm-${{ hashFiles('package-lock.json') }}
+        restore-keys: |
+          npm-${{ hashFiles('package-lock.json') }}
+          npm-
+    - run: npm ci
+    - run: npm run bundle
+    - name: Store bundle artifact
+      uses: actions/upload-artifact@v2
+      with:
+        name: bundles
+        path: bundles
+        retention-days: 1
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - run: npm ci
+    - run: npm test
+  e2e-tests:
+    needs: [bundle]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - run: npm ci
+    - name: Download bundled artifact
+      uses: actions/download-artifact@v2
+      with:
+        name: bundles
+        path: bundles
+    - run: npm run e2e
+  # disable this for now
+  # deploy-demo:
+  #   needs: [bundle, unit-tests, e2e-tests]
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v1
+  #     - name: Configure AWS Credentials
+  #       uses: aws-actions/configure-aws-credentials@v1
+  #       with:
+  #         aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+  #         aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+  #         aws-region: us-east-1
+  #     - name: Install dependencies
+  #       run: npm ci
+  #     - name: Download bundled artifacts
+  #       uses: actions/download-artifact@v2
+  #       with:
+  #         name: bundles
+  #         path: bundles
+  #     - name: Build package
+  #       run: npm run build:demo
+  #     - name: Deploy to S3 bucket
+  #       run: npm run deploy:demo
+  #     - name: Invalidate
+  #       run: aws cloudfront create-invalidation --distribution-id ${{ secrets.CF_DEMO_DISTRIBUTION_ID }} --paths "/*"
+  publish:
+    needs: [bundle, unit-tests, e2e-tests]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "14.x"
+          registry-url: 'https://registry.npmjs.org'
+      - uses: actions/checkout@v2
+      - name: Download bundled artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: bundles
+          path: bundles
+      - name: Cache node modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+          key: npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            npm-${{ hashFiles('package-lock.json') }}
+            npm-
+      - name: Before deploy
+        run: npm ci && npm run declarations
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}