Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
7b2931d
sync: Synced local 'docs/' with remote 'docs/redoc/'
Nov 9, 2023
8c04c02
docs: fix admonition on config page (#2452)
adamaltman Nov 13, 2023
e9f9799
Update README.md (#2422)
lexigen Nov 13, 2023
0db1e98
docs: Remove references to interactive docs in the open source projec…
lornajane Dec 1, 2023
21b961d
Add Quaderno API to README's Showcase section (#2468)
jrub Dec 28, 2023
76cecf0
chore: Update directory structure for Vale v3 (#2477)
lornajane Jan 17, 2024
4fd22f6
docs: Add docs tooling to align with publishing to main site (#2484)
lornajane Jan 29, 2024
8c39149
docs: Fix a link that couldn't be checked as it reaches outside the R…
lornajane Feb 12, 2024
3f3f955
docs: Update API examples list to include Museum API (#2506)
lornajane Apr 2, 2024
1f11f59
chore: fix vulnerabilities and upgrade deps (#2445)
AlexVarchuk Apr 24, 2024
9af774e
chore: add check-version to publish script (#2446)
AlexVarchuk Apr 24, 2024
edac972
fix: publish script (#2524)
AlexVarchuk Apr 24, 2024
20a923b
chore: upgrade openapi-sampler (#2525)
AlexVarchuk Apr 24, 2024
ff91768
chore: upgrade cypress to fix e2e tests and update-browserslist-db (#…
AlexVarchuk Apr 25, 2024
2b72dc0
fix: use h2/h3 for headings instead of h1/h2 for better seo (#2514)
maxkrumpe Apr 25, 2024
b0d03d0
fix: add deprecated css to clickable property name (#2526)
keremnalbant Apr 25, 2024
a661320
chore: v2.1.4 (#2530)
AlexVarchuk Apr 25, 2024
50c7f60
chore: fix docker publish action (#2531)
AlexVarchuk Apr 25, 2024
31d88a1
docs: Remove outdated sync job for docs folder (#2465)
lornajane Apr 26, 2024
72dd57d
chore: move jest-environment-jsdom to dev dependencies (#2543)
AlexVarchuk Jun 6, 2024
c664dd0
fix: update react to 18 and react-tabs to 6 (#2547)
AlexVarchuk Jun 6, 2024
3658b6d
chore: v2.1.5 (#2550)
AlexVarchuk Jun 10, 2024
d0543bb
chore: upgrade vulnerable dev dependencies
RomanHotsiy Aug 1, 2024
e066677
chore: remove heavy bundlesize dev dependency
RomanHotsiy Aug 1, 2024
a7607ea
docs: update broken link of Openapi Object (#2577)
AlexVarchuk Aug 29, 2024
60d131b
fix: show siblings schema with oneOf (#2576)
AlexVarchuk Aug 29, 2024
c813eea
docs: fix http-server example from in-page feedback (#2580)
lornajane Sep 2, 2024
c0203be
chore: upgrade node version for docker (#2589)
AlexVarchuk Sep 13, 2024
c04b4c8
docs: Remove the old zero-dependency claim for Redoc docs (#2590)
lornajane Sep 16, 2024
d193dd2
chore: Remove the sync job, we don't use it any more (#2591)
lornajane Sep 19, 2024
c0c6820
chore(deps): bump body-parser and express (#2603)
dependabot[bot] Oct 15, 2024
1cceed4
chore(deps): bump dompurify from 3.0.6 to 3.1.3 (#2602)
dependabot[bot] Oct 15, 2024
64f1877
feat: add support x-badges (#2605)
AlexVarchuk Oct 16, 2024
4736c54
chore: v2.2.0 (#2606)
AlexVarchuk Oct 16, 2024
1593d01
fix: docker build (#2607)
AlexVarchuk Oct 16, 2024
11912f5
docs(all): change admonition type to 'info' (#2608)
TaylorKrusen Oct 18, 2024
c3fce4e
chore: updated webpack version to 5.94.0 (#2583)
Dxuian Oct 28, 2024
aa0879c
feat: update pattern styling (#2196) (#2600)
miqh Oct 28, 2024
639fd2c
chore: npm audit for previnting feature vulnerabilities (#2612)
AlexVarchuk Oct 28, 2024
85b622f
fix: displaying nested items with type string (#2634)
AlexVarchuk Dec 31, 2024
d614d2d
fix: passing inline parameters after support react 18 for response ti…
AlexVarchuk Jan 6, 2025
59ee73f
fix: displaying json example when showObjectSchemaExamples enabled (#…
AlexVarchuk Jan 8, 2025
981e4a8
chore: move @cfaester/enzyme-adapter-react-18 to devDependencies (#2625)
wadakatu Jan 16, 2025
8caddaf
chore(deps-dev): bump micromatch from 4.0.4 to 4.0.8 (#2578)
dependabot[bot] Jan 16, 2025
0e2d595
chore: fix vulnerabilities (#2648)
AlexVarchuk Jan 16, 2025
c765b34
chore: v2.3.0 (#2649)
AlexVarchuk Jan 16, 2025
153ec7a
fix: Prototype Pollution Vulnerability Affecting redoc <=2.2.0 (#2638)
KsAkira10 Jan 28, 2025
ae1ae79
docs: update options for future major release (#2646)
AlexVarchuk Jan 30, 2025
53a6afc
fix: unify redoc config (#2647)
AlexVarchuk Jan 30, 2025
3a74802
feat: add supporting react 19 in package.json (#2652)
AlexVarchuk Feb 5, 2025
6fa5a2a
fix: update version download/upload artifacts in cicd (#2656)
AlexVarchuk Feb 7, 2025
1243095
chore: v2.4.0 (#2658)
ivankropyvnytskyi Feb 7, 2025
cab07ba
chore(deps): bump prismjs from 1.29.0 to 1.30.0 (#2672)
dependabot[bot] Mar 11, 2025
7cedd59
chore(deps): bump dompurify from 3.1.3 to 3.2.4 (#2667)
dependabot[bot] Apr 8, 2025
1fa1327
chore(deps): bump esbuild and esbuild-loader (#2661)
dependabot[bot] Apr 8, 2025
1b4126f
feat: add keyboard navigation support to JsonViewer component (#2654)
ImBIOS Apr 14, 2025
2db293b
fix: enhance accessibility for menu items with keyboard support (#2655)
ImBIOS Apr 14, 2025
05a04c8
chore(deps): bump @babel/runtime from 7.23.2 to 7.27.0 (#2679)
dependabot[bot] Apr 14, 2025
4547613
chore: fix moderate vulnerabilities (#2683)
AlexVarchuk Apr 14, 2025
00bc6ed
chore: v2.5.0 (#2684)
AlexVarchuk Apr 14, 2025
3ae251b
docs: remove deprecated CLI commands from docs (#2691)
tatomyr May 20, 2025
ce27184
fix: fix headin slugs
RomanHotsiy May 28, 2025
ba863af
chore(deps-dev): bump http-proxy-middleware from 2.0.7 to 2.0.9 (#2687)
dependabot[bot] Jun 26, 2025
7a91902
chore(deps): bump form-data and @cypress/request (#2704)
dependabot[bot] Jul 22, 2025
4d15a1f
chore(deps-dev): bump webpack-dev-server from 4.15.1 to 5.2.1 (#2695)
dependabot[bot] Jul 30, 2025
0b55f34
chore(deps): bump brace-expansion (#2716)
dependabot[bot] Sep 5, 2025
d140213
chore: v2.5.1 (#2726)
DmitryAnansky Sep 26, 2025
65b6997
chore(deps): bump on-headers and compression (#2703)
dependabot[bot] Oct 9, 2025
a59afd5
chore(deps): bump openapi-sampler from 1.5.0 to 1.6.2 (#2732)
ivankropyvnytskyi Oct 15, 2025
3462357
chore: v2.5.2 (#2733)
ivankropyvnytskyi Oct 15, 2025
acdb04b
chore(deps-dev): bump cypress from 13.8.1 to 15.5.0 (#2737)
EvilCoreS Nov 5, 2025
81e19cb
Revert "chore(deps-dev): bump cypress from 13.8.1 to 15.5.0 (#2737)" …
EvilCoreS Nov 5, 2025
d41fd46
chore(deps-dev): use tmp >= 0.2.4 (#2739)
EvilCoreS Nov 5, 2025
297a31c
Styling changes
PhilippeChab Jul 23, 2020
7f60733
More style changes
PhilippeChab Nov 2, 2023
82324a4
Export standalone
PhilippeChab Nov 2, 2023
70b71ce
Run npm audit fix
ivankropyvnytskyi Oct 15, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .github/sync.yml

This file was deleted.

37 changes: 37 additions & 0 deletions .github/workflows/docs-tests.yaml
Original file line number Diff line number Diff line change
@@ -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/mlc@v0.16.1
with:
args: ./docs
37 changes: 28 additions & 9 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ name: Publish

on:
push:
tags:
- v[0-9]*.[0-9]*.[0-9]*
branches: [main]

jobs:
bundle:
Expand All @@ -22,7 +21,7 @@ jobs:
- run: npm ci
- run: npm run bundle
- name: Store bundle artifact
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: bundles
path: bundles
Expand All @@ -40,14 +39,32 @@ jobs:
- uses: actions/checkout@v3
- run: npm ci
- name: Download bundled artifact
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: bundles
path: bundles
- run: npm run e2e
check-version:
name: Check Version
runs-on: ubuntu-latest
needs: [bundle, unit-tests, e2e-tests]
outputs:
changed: ${{ steps.check.outputs.changed }}
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Node.js
uses: actions/setup-node@v3
- name: Check if version has been updated
id: check
uses: EndBug/version-check@v2.0.1
with:
file-url: https://cdn.jsdelivr.net/npm/redoc/package.json
static-checking: localIsNew
publish:
name: Publish to NPM
needs: [bundle, unit-tests, e2e-tests]
needs: [check-version]
if: needs.check-version.outputs.changed == 'true'
runs-on: ubuntu-latest
steps:
- uses: actions/setup-node@v3
Expand All @@ -56,7 +73,7 @@ jobs:
registry-url: 'https://registry.npmjs.org'
- uses: actions/checkout@v3
- name: Download bundled artifacts
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: bundles
path: bundles
Expand All @@ -77,7 +94,8 @@ jobs:

publish-cdn:
name: Publish to CDN
needs: [bundle, unit-tests, e2e-tests]
needs: [check-version]
if: needs.check-version.outputs.changed == 'true'
runs-on: ubuntu-latest
steps:
- name: Checkout repository
Expand All @@ -89,14 +107,15 @@ jobs:
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- name: Download all artifact
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
- name: Publish to S3
run: npm run publish-cdn

invalidate-cache:
name: Clear cache
runs-on: ubuntu-latest
needs: [publish, publish-cdn]
needs: [check-version, publish, publish-cdn]
if: needs.check-version.outputs.changed == 'true'
steps:
- name: Checkout repository
uses: actions/checkout@v3
Expand Down
18 changes: 0 additions & 18 deletions .github/workflows/sync.yml

This file was deleted.

16 changes: 0 additions & 16 deletions .github/workflows/vale.yaml

This file was deleted.

54 changes: 54 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions .mlc.toml
Original file line number Diff line number Diff line change
@@ -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"
94 changes: 94 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,97 @@
# [2.5.2](https://github.com/Redocly/redoc/compare/v2.5.1...v2.5.2) (2025-10-15)


### Bug Fixes

* Bumped `openapi-sampler` dependency to include the fix for `readOnly`/`writeOnly` handling in allOf.


# [2.5.1](https://github.com/Redocly/redoc/compare/v2.4.0...v2.5.1) (2025-09-26)


### Bug Fixes

* Bumped `mobx-react` dependency to address a security vulnerability.

# [2.5.0](https://github.com/Redocly/redoc/compare/v2.4.0...v2.5.0) (2025-04-14)


### Bug Fixes

* enhance accessibility for menu items with keyboard support ([#2655](https://github.com/Redocly/redoc/issues/2655)) ([2db293b](https://github.com/Redocly/redoc/commit/2db293bfb2973497dd33f31dc99e97f5bb90bbe8))


### Features

* add keyboard navigation support to JsonViewer component ([#2654](https://github.com/Redocly/redoc/issues/2654)) ([1b4126f](https://github.com/Redocly/redoc/commit/1b4126fde4531387f49c90f52efbd0c0e5f7b6ea))



# [2.4.0](https://github.com/Redocly/redoc/compare/v2.3.0...v2.4.0) (2025-02-07)


### Bug Fixes

* Prototype Pollution Vulnerability Affecting redoc <=2.2.0 ([#2638](https://github.com/Redocly/redoc/issues/2638)) ([153ec7a](https://github.com/Redocly/redoc/commit/153ec7a0b7245639f404c0b038b612ae7377c7db))
* unify redoc config ([#2647](https://github.com/Redocly/redoc/issues/2647)) ([53a6afc](https://github.com/Redocly/redoc/commit/53a6afc59624fe4591b0a0f1f20f41c0fbb5f1cf))


### Features

* add supporting react 19 in package.json ([#2652](https://github.com/Redocly/redoc/issues/2652)) ([3a74802](https://github.com/Redocly/redoc/commit/3a748022be3a7dc7f98669e1645dd5cda72f1abc))



# [2.3.0](https://github.com/Redocly/redoc/compare/v2.2.0...v2.3.0) (2025-01-16)


### Bug Fixes

* displaying json example when showObjectSchemaExamples enabled ([#2635](https://github.com/Redocly/redoc/issues/2635)) ([59ee73f](https://github.com/Redocly/redoc/commit/59ee73fefa8e8edb398940076bdd721fc284caa3))
* displaying nested items with type string ([#2634](https://github.com/Redocly/redoc/issues/2634)) ([85b622f](https://github.com/Redocly/redoc/commit/85b622fc581eb96303aeb85056aef36c74ea9f9d))
* passing inline parameters after support react 18 for response title ([#2640](https://github.com/Redocly/redoc/issues/2640)) ([d614d2d](https://github.com/Redocly/redoc/commit/d614d2d022df8bd1989cb0eaf76d087b52120d36))


### Features

* update pattern styling ([#2196](https://github.com/Redocly/redoc/issues/2196)) ([#2600](https://github.com/Redocly/redoc/issues/2600)) ([aa0879c](https://github.com/Redocly/redoc/commit/aa0879ca0235112918428fdff8f4c48d2c6c4adf))



# [2.2.0](https://github.com/Redocly/redoc/compare/v2.1.5...v2.2.0) (2024-10-16)


### Bug Fixes

* show siblings schema with oneOf ([#2576](https://github.com/Redocly/redoc/issues/2576)) ([60d131b](https://github.com/Redocly/redoc/commit/60d131b0a9dab4710e900323c9ba81160cecf7d8))


### Features

* add support x-badges ([#2605](https://github.com/Redocly/redoc/issues/2605)) ([64f1877](https://github.com/Redocly/redoc/commit/64f18779e5fe7e03f25862463cbc5062e85c867c))



## [2.1.5](https://github.com/Redocly/redoc/compare/v2.1.4...v2.1.5) (2024-06-10)


### Bug Fixes

* update react to 18 and react-tabs to 6 ([#2547](https://github.com/Redocly/redoc/issues/2547)) ([c664dd0](https://github.com/Redocly/redoc/commit/c664dd0d56571ce799b8eadd081d86a6b2cdefae))



## [2.1.4](https://github.com/Redocly/redoc/compare/v2.1.3...v2.1.4) (2024-04-25)


### Bug Fixes

* add deprecated css to clickable property name ([#2526](https://github.com/Redocly/redoc/issues/2526)) ([b0d03d0](https://github.com/Redocly/redoc/commit/b0d03d02069c1508447ddebc2f8a3fffa9b03ce5))
* use h2/h3 for headings instead of h1/h2 for better seo ([#2514](https://github.com/Redocly/redoc/issues/2514)) ([2b72dc0](https://github.com/Redocly/redoc/commit/2b72dc0e90f759a8ee2e47691c844e7f05928a24))
* security vulnerability ([#2445](https://github.com/Redocly/redoc/pull/2445)) ([1f11f5](https://github.com/Redocly/redoc/commit/1f11f597c4f10ddd601db247f5034052b6ca689f))



## [2.1.3](https://github.com/Redocly/redoc/compare/v2.1.2...v2.1.3) (2023-10-24)


Expand Down
Loading
Loading