SWI-4287 Sync Fork (#36)

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

* chore: remove broken link from demo (Redocly#2338)

* fix: renames 'FieldContstraints' to 'FieldConstraints' (Redocly#2352)

Co-authored-by: Ricagraca <[email protected]>

* fix: schema oneOf title with const (Redocly#2350)

* docs: adds vale rules and workflow for running in CI (Redocly#2348)

* docs: adds vale rules and workflow for running in CI

* docs: updates product name from ReDoc to Redoc

* chore: update packages dependecy (Redocly#2360)

* chore: update packages dependecy

* fix: remove redundant options

* fix: webpack config demo folder

* fix: replace cypress ts-loader

* chore: remove redundant dependency

* chore(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 (Redocly#2359)

Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](jonschlinkert/word-wrap@1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: enable keyboard navigation (Redocly#2361)

* docs: fix and update links in redoc-vendor-extensions (Redocly#2368)

Co-authored-by: Lorna Jane Mitchell <[email protected]>

* feat: add x-tags (Redocly#2355)

* feat: add x-tags

* chore: fix e2e tests and add new for x-tag

* chore: add x-tags to demo definition

* chore: update snapshots

* feat: add support of react 18 (Redocly#2369)

* feat: add support of react 18

* chore: add newest version of styled-components to peerDependencies

* chore: add supoort of styled components

* chore: downgrade types

* chore: update snapshots

* chore: update cypress to 12.17.1

* chore: upgrade openapi-core to 1.0.0-rc.2

* chore: upgrade packages for fixing vulnerabilities

* docs: Remove Redoc CLI and a non-existent config option

* chore: v2.1.0 (Redocly#2382)

* fix: hotfix, crash after 2.1 release

* chore: v2.1.1

* chore: add tests for cover field default crash (Redocly#2389)

* fix: react18 cli integration (Redocly#2404)

* fix: react18 cli integration

* fix: update unit tests snapshots

* chore(deps): bump @cypress/request and cypress (Redocly#2410)

Bumps [@cypress/request](https://github.com/cypress-io/request) to 3.0.1 and updates ancestor dependency [cypress](https://github.com/cypress-io/cypress). These dependencies need to be updated together.


Updates `@cypress/request` from 2.88.11 to 3.0.1
- [Release notes](https://github.com/cypress-io/request/releases)
- [Changelog](https://github.com/cypress-io/request/blob/master/CHANGELOG.md)
- [Commits](cypress-io/request@v2.88.11...v3.0.1)

Updates `cypress` from 12.17.1 to 13.1.0
- [Release notes](https://github.com/cypress-io/cypress/releases)
- [Changelog](https://github.com/cypress-io/cypress/blob/develop/CHANGELOG.md)
- [Commits](cypress-io/cypress@v12.17.1...v13.1.0)

---
updated-dependencies:
- dependency-name: "@cypress/request"
  dependency-type: indirect
- dependency-name: cypress
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: style RefreshToken URL as <code> in the authorization section

Co-authored-by: szaszeke <[email protected]>

* chore: v2.1.2 (Redocly#2413)

* fix: more cases for react18 and cli integration (Redocly#2416)

* Config docs and README refresh (Redocly#2393)

* docs: Give Redoc a landing page with overview and tldr instructions

* docs: move config to dedicated page

* docs: modernise README, link to resources

* docs: more detailed format for theme configurations

* fix: README formatting

* fix: Fix future tense errors and add exceptions for config fields as headings

* Apply suggestions from code review

Co-authored-by: Heather Cloward <[email protected]>

* docs: minor updates from excellent pull request feedback

* docs: Remove the old quickstart, update HTML as the preferred onboarding method and improve docs/examples on that page

* Apply suggestions from code review

Co-authored-by: Heather Cloward <[email protected]>

---------

Co-authored-by: Heather Cloward <[email protected]>

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

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

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

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

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

* chore(deps-dev): bump postcss from 8.4.27 to 8.4.31 (Redocly#2427)

Bumps [postcss](https://github.com/postcss/postcss) from 8.4.27 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.4.27...8.4.31)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

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

* fix: default value as object in request body (Redocly#2437)

* fix: hideRequestPayloadSample (Redocly#2436)

* fix: display string pattern in array items (Redocly#2438)

* chore: v2.1.3 (Redocly#2439)

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

* docs: fix admonition on config page (Redocly#2452)

* Update README.md (Redocly#2422)

Fix link to deployment options

* docs: Remove references to interactive docs in the open source project (Redocly#2460)

* docs: Remove references to interactive docs in the open source project

* Update README.md

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

---------

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

* Add Quaderno API to README's Showcase section (Redocly#2468)

* chore: Update directory structure for Vale v3 (Redocly#2477)

* chore: Update directory structure for Vale v3

* chore: update Vale folder name

* docs: Add docs tooling to align with publishing to main site (Redocly#2484)

* docs: add markdownlint and some link checks alongside vale

* docs: add link checker config and fix/update some links reported broken

* docs: update markdownlint action

* docs: fix markdown table formatting

* docs: Unpin Vale version and pick up the latest

* docs: Fix a link that couldn't be checked as it reaches outside the Redoc project (Redocly#2490)

* docs: Update API examples list to include Museum API (Redocly#2506)

* feat: Update API examples list to include Museum API

* updates museum.yaml with logo and replaces petstore with museum api in playground for local dev and some minor edits to redoc name

* docs: update definition

---------

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

* chore: fix vulnerabilities and upgrade deps (Redocly#2445)

* chore: fix vulnerabilities and upgrade deps

* chore: use old version of cypress

* fix: additional vulnerabilities

* chore: add check-version to publish script (Redocly#2446)

* fix: publish script (Redocly#2524)

* chore: upgrade openapi-sampler (Redocly#2525)

* chore: upgrade cypress to fix e2e tests and update-browserslist-db (Redocly#2529)

* fix: use h2/h3 for headings instead of h1/h2 for better seo (Redocly#2514)

* fix: use h2/h3 for headings instead of h1/h2 for better seo

* fix: fixed e2e tests for changed headings

---------

Co-authored-by: Max Krumpe <[email protected]>

* fix: add deprecated css to clickable property name (Redocly#2526)

Co-authored-by: Kerem Nalbant <[email protected]>

* chore: v2.1.4 (Redocly#2530)

* chore: fix docker publish action (Redocly#2531)

* docs: Remove outdated sync job for docs folder (Redocly#2465)

* chore: move jest-environment-jsdom to dev dependencies (Redocly#2543)

* fix: update react to 18 and react-tabs to 6 (Redocly#2547)

* chore: v2.1.5 (Redocly#2550)

* chore: upgrade vulnerable dev dependencies

* chore: remove heavy bundlesize dev dependency

* docs: update broken link of Openapi Object (Redocly#2577)

* fix: show siblings schema with oneOf (Redocly#2576)

* docs: fix http-server example from in-page feedback (Redocly#2580)

* chore: upgrade node version for docker (Redocly#2589)

* docs: Remove the old zero-dependency claim for Redoc docs (Redocly#2590)

* chore: Remove the sync job, we don't use it any more (Redocly#2591)

* chore(deps): bump body-parser and express (Redocly#2603)

Bumps [body-parser](https://github.com/expressjs/body-parser) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together.

Updates `body-parser` from 1.20.2 to 1.20.3
- [Release notes](https://github.com/expressjs/body-parser/releases)
- [Changelog](https://github.com/expressjs/body-parser/blob/master/HISTORY.md)
- [Commits](expressjs/body-parser@1.20.2...1.20.3)

Updates `express` from 4.19.2 to 4.21.1
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/4.21.1/History.md)
- [Commits](expressjs/express@4.19.2...4.21.1)

---
updated-dependencies:
- dependency-name: body-parser
  dependency-type: indirect
- dependency-name: express
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump dompurify from 3.0.6 to 3.1.3 (Redocly#2602)

Bumps [dompurify](https://github.com/cure53/DOMPurify) from 3.0.6 to 3.1.3.
- [Release notes](https://github.com/cure53/DOMPurify/releases)
- [Commits](cure53/DOMPurify@3.0.6...3.1.3)

---
updated-dependencies:
- dependency-name: dompurify
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: add support x-badges (Redocly#2605)

* feat: add support x-badges

Co-authored-by: Max Mueller <[email protected]>

* chore: try to fix e2e tests

* chore: try to fix e2e tests part 2

* Update docs/redoc-vendor-extensions.md

---------

Co-authored-by: Max Mueller <[email protected]>
Co-authored-by: Jacek Łękawa <[email protected]>

* chore: v2.2.0 (Redocly#2606)

* fix: docker build (Redocly#2607)

* docs(all): change admonition type to 'info' (Redocly#2608)

* chore: updated webpack version to 5.94.0 (Redocly#2583)

* feat: update pattern styling (Redocly#2196) (Redocly#2600)

Closes Redocly#2196

* chore: npm audit for previnting feature vulnerabilities (Redocly#2612)

* formatting

* readme formatting

* operations

* types

* utils

* badges in spec

* update package lock

* snapshots

* wf updates

* spec

* snapshot

* search tests

* fix e2e tests

* update styled-components

* dont update

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: redocly-bot <null>
Co-authored-by: Alex Varchuk <[email protected]>
Co-authored-by: Ricardo Graça <[email protected]>
Co-authored-by: Ricagraca <[email protected]>
Co-authored-by: Heather Cloward <[email protected]>
Co-authored-by: Oprysk Viacheslav <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Roman Pidkostelnyi <[email protected]>
Co-authored-by: Adam Altman <[email protected]>
Co-authored-by: Lorna Jane Mitchell <[email protected]>
Co-authored-by: Lorna Mitchell <[email protected]>
Co-authored-by: Roman Hotsiy <[email protected]>
Co-authored-by: ckszabi <[email protected]>
Co-authored-by: szaszeke <[email protected]>
Co-authored-by: Andrew Tatomyr <[email protected]>
Co-authored-by: Alexei Maridashvili <[email protected]>
Co-authored-by: Javi Rubio <[email protected]>
Co-authored-by: Max Krumpe <[email protected]>
Co-authored-by: Max Krumpe <[email protected]>
Co-authored-by: Kerem Nalbant <[email protected]>
Co-authored-by: Kerem Nalbant <[email protected]>
Co-authored-by: Max Mueller <[email protected]>
Co-authored-by: Jacek Łękawa <[email protected]>
Co-authored-by: Taylor Krusen <[email protected]>
Co-authored-by: Dxuian <[email protected]>
Co-authored-by: Michael Huynh <[email protected]>

Author: 25 people

.github/styles/config/vocabularies/Rules/accept.txt

@@ -0,0 +1,150 @@
+[Aa]nsible
+[Aa]utostart
+[Bb]locklist
+[Bb]locklists
+[Bb]oolean
+[Bb]reakpoint
+[B]reakpoints
+[Cc]ancelation
+[Cc]lassloading
+[Cc]hargeback
+[Cc]hargebacks
+[Cc]he
+[Cc]rypto
+[Cc]ryptocurrency
+[Dd]evfile|[Dd]evfiles
+[Dd]ownstream
+[Dd]ownstreaming
+[Ff]actories|[Ff]actory
+[Gg]it
+[Gg]rafana
+[Hh]eatmap
+[Hh]elm
+[Hh]ostname
+[Ii]tem
+[Jj]etbrains
+[Kk]eycloak
+[Ll]iveness
+[Ll]ombok
+[Ll]oopback
+[Mm]aven
+[Mm]inikube
+[Mm]inishift
+[Mm]ixin|[Mm]ixins
+[Mm]odularization
+[Mm]ulticluster
+[Mm]ultihost
+[Mm]ultinode
+[Mm]ultitenant
+[Mm]ultiuser
+[Mm]ultizone
+[Nn]amespace|[Nn]amespaces
+[Nn]etcoredebug[Oo]utput
+[Nn]ginx
+[Oo]nboarding
+[Pp]podman
+[Pp]reconfigured
+[Rr]eadonly
+[Rr]epresentment
+[Rr]ollout|[Rr]ollouts
+[Rr]untime|[Rr]untimes
+[Ss]erializer
+[Ss]erverless
+[Ss]ubnetwork
+[Ss]ubpath|[Ss]ubpaths
+[Tt]heia
+[Tt]olerations
+[Tt]ruststore
+[Uu]ninstallation
+[Uu]nstaged
+[Uu]ntrusted
+[Ww]orkspace|[Ww]orkspaces
+[Yy]eoman
+\.NET
+adoc
+Antora
+API
+Apigee
+AsciiDoc
+AWS|aws
+Azure
+Bierner
+Bitbucket
+btn
+Btrfs
+CentOS
+Ceph
+Che-Theia
+CLI
+ConfigMap|ConfigMaps
+Ctrl
+DaemonSet
+Dev Workspace
+Developer Perspective
+DNS
+Docker
+Dockerfile
+Dotnet
+Endevor
+endif
+GitHub|github
+GitLab
+Gluster
+Gradle
+Grafana
+GUI
+HTTPS|https
+I/O
+IDE|ide|IDEs
+Intelephense
+IntelliJ IDEA
+Java
+Java Lombok
+JSON|json
+JVM|jvm
+kbd
+Kubespray
+Laravel
+Let\'s Encrypt
+Mattermost
+mebibytes
+Microsoft Azure
+millicores
+Mulesoft
+MySQL
+Netlify
+Node.js
+npm
+NuGet
+OAuth
+ocp
+OmniSharp
+OpenShift
+OpenTracing
+Operator
+OperatorHub
+OpenAPI
+osd
+PHP
+PostgreSQL
+Quarkus
+Rebilly
+Redoc
+Redocly
+Redocly-cli
+SCM
+Sharding
+SonarLint
+Spring Boot
+SVG
+Uber
+URI|URIs
+URL|url|URLs
+Velero
+Vercel
+Visual Studio Code
+vsix
+Webview|Webviews
+Woopra
+YAML|yaml
+Zowe

.github/styles/config/vocabularies/Rules/reject.txt

@@ -0,0 +1,37 @@
+name: Documentation tests
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  markdownlint:
+    name: markdownlint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: DavidAnson/markdownlint-cli2-action@v15
+        with:
+          config: .markdownlint.yaml
+          globs: |
+            docs/**/*.md
+            README.md
+
+  vale:
+    name: vale action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: errata-ai/vale-action@reviewdog
+        with:
+          files: '["README.md", "docs"]'
+          filter_mode: file
+
+  linkcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Markup Link Checker (mlc)
+        uses: becheran/[email protected]
+        with:
+          args: ./docs

.github/sync.yml

@@ -10,7 +10,7 @@ jobs:
   build-and-e2e:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm ci
       - run: npm run bundle
       - run: npm run e2e

.github/workflows/docs-tests.yaml

@@ -11,13 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
 
       - name: Cache node modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
           key: npm-${{ hashFiles('package-lock.json') }}
@@ -32,7 +32,7 @@ jobs:
         run: npm run bundle
 
       - name: Store bundle artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: bundles
           path: bundles
@@ -43,7 +43,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Clean Install
         run: npm ci
@@ -57,13 +57,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Clean Install
         run: npm ci
 
       - name: Download bundled artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bundles
           path: bundles
@@ -86,16 +86,16 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Download bundled artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bundles
           path: bundles
 
       - name: Cache node modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
           key: npm-${{ hashFiles('package-lock.json') }}
@@ -143,22 +143,22 @@ jobs:
           fi
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: '14.x'
+          node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Download bundled artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: bundles
           path: bundles
 
       - name: Cache node modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
           key: npm-${{ hashFiles('package-lock.json') }}

.github/workflows/e2e-tests.yml

@@ -10,7 +10,7 @@ jobs:
   build-and-unit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm ci
       - run: npm run bundle
       - run: npm test

.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+---
+# Default rules: https://github.com/github/super-linter/blob/master/TEMPLATES/.markdown-lint.yml
+
+# Rules by id
+
+# Unordered list style
+MD004: false
+
+# Unordered list indentation
+MD007:
+  indent: 2
+
+MD013:
+  # TODO: Consider to decrease allowed line length
+  line_length: 800
+  tables: false
+
+## Allow same headers in siblings
+MD024:
+  siblings_only: true
+
+# Multiple top level headings in the same document
+MD025:
+  front_matter_title: ''
+
+# Trailing punctuation in heading
+MD026:
+  punctuation: '.,;:。，；:'
+
+# Ordered list item prefix
+MD029: false
+
+# Unordered lists inside of ordered lists
+MD030: false
+
+# Inline HTML
+MD033: false
+
+# No bare urls
+MD034: false
+
+# Emphasis used instead of a heading
+MD036: false
+
+# Disable "First line in file should be a top level heading"
+# We use uncommon format to add metadata.
+# TODO: Consider to use "YAML front matter".
+MD041: false
+
+# Rules by tags
+blank_lines: false
+
+MD046: false
+# code-block-style

.github/workflows/unit-tests.yml

@@ -0,0 +1,4 @@
+# Ignore these links, we can't check them from this subproject
+ignore-links=["../*", "/docs/*"]
+# Path to the root folder used to resolve all relative paths
+root-dir="./docs"