Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: v2.4.0 #2658

Merged
merged 1 commit into from
Feb 7, 2025
+18 −3
Merged

chore: v2.4.0 #2658

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
# [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)


4 changes: 2 additions & 2 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "redoc",
"version": "2.3.0",
"version": "2.4.0",
"description": "ReDoc",
"repository": {
"type": "git",

Unchanged files with check annotations Beta

View file
docs/redoc-vendor-extensions.md
# Redoc vendor extensions
You can use the following [vendor extensions](https://redocly.com/docs/openapi-visual-reference/specification-extensions/) with Redoc.

Check warning on line 3 in docs/redoc-vendor-extensions.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/openapi-visual-reference/specification-extensions/. 200 - OK
- [Redoc vendor extensions](#redoc-vendor-extensions)
- [Swagger Object](#swagger-object)
- [How to use with Redoc](#how-to-use-with-redoc-9)
- [x-additionalPropertiesName example](#x-additionalpropertiesname-example)
- [x-explicitMappingOnly](#x-explicitmappingonly)
- [How to use with Redoc](#how-to-use-with-redoc-10)

Check failure on line 43 in docs/redoc-vendor-extensions.md

GitHub Actions / markdownlint

Link fragments should be valid 

docs/redoc-vendor-extensions.md:43:9 MD051/link-fragments Link fragments should be valid [Context: "[How to use with Redoc](#how-to-use-with-redoc-10)"] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md051.md
- [x-explicitMappingOnly example](#x-explicitmappingonly-example)
- [x-enumDescriptions](#x-enumdescriptions)
- [How to use with Redoc](#how-to-use-with-redoc-11)

Check failure on line 46 in docs/redoc-vendor-extensions.md

GitHub Actions / markdownlint

Link fragments should be valid 

docs/redoc-vendor-extensions.md:46:9 MD051/link-fragments Link fragments should be valid [Context: "[How to use with Redoc](#how-to-use-with-redoc-11)"] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md051.md
- [x-enumDescriptions example](#x-enumdescriptions-example)
## Swagger Object
#### Fixed fields
| Field Name | Type | Description |
| :---------- | :------: | :----------- |
| lang | string | Code sample language. Value should be one of the following [list](https://github.com/github/linguist/blob/master/lib/linguist/popular.yml) |

Check warning on line 210 in docs/redoc-vendor-extensions.md

GitHub Actions / linkcheck

link checker warning

| label | string? | Code sample label, for example `Node` or `Python2.7`, _optional_, `lang` is used by default |
| source | string | Code sample source code |
| x-badges | [[Badge Object](https://redocly.com/docs/realm/author/reference/openapi-extensions/x-badges#badge-object)] | A list of badges associated with the operation |
## Parameter Object
Extends the OpenAPI [Parameter Object](https://redocly.com/docs/openapi-visual-reference/parameter/)

Check warning on line 235 in docs/redoc-vendor-extensions.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/openapi-visual-reference/parameter/. 200 - OK
### x-examples
| Field Name | Type | Description |
`x-examples` are rendered in the JSON tab on the right panel in Redoc.
## Response Object vendor extensions
Extends the OpenAPI [Response Object](https://redocly.com/docs/openapi-visual-reference/response/).

Check warning on line 246 in docs/redoc-vendor-extensions.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/openapi-visual-reference/response/. 200 - OK
### x-summary
| Field Name | Type | Description |
If specified, you can use `x-summary` as the response button text, with description rendered under the button.
## Schema Object
Extends the OpenAPI [Schema Object](https://redocly.com/docs/openapi-visual-reference/schemas/)

Check warning on line 257 in docs/redoc-vendor-extensions.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/openapi-visual-reference/schemas/. 200 - OK
### x-nullable
| Field Name | Type | Description |
View file
docs/deployment/docker.md
Redoc is available as a pre-built Docker image in [Docker Hub](https://hub.docker.com/r/redocly/redoc/).
If you have [Docker](https://docs.docker.com/get-docker/) installed, pull the image with the following command:

Check warning on line 10 in docs/deployment/docker.md

GitHub Actions / linkcheck

link checker warning 

https://docs.docker.com/get-docker/. Request was redirected to https://docs.docker.com/get-started/get-docker/
```docker
docker pull redocly/redoc
View file
docs/config.md
### OpenAPI specification extensions
Redoc uses the following [specification extensions](https://redocly.com/docs-legacy/api-reference-docs/spec-extensions/):

Check warning on line 298 in docs/config.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs-legacy/api-reference-docs/spec-extensions/. 200 - OK
* [`x-logo`](./redoc-vendor-extensions.md#x-logo) - is used to specify API logo
* [`x-traitTag`](./redoc-vendor-extensions.md#x-traittag) - useful for handling out common things like Pagination, Rate-Limits, etc
* [`x-codeSamples`](./redoc-vendor-extensions.md#x-codesamples) - specify operation code samples
View file
docs/deployment/intro.md
- [Fitbit Plus OpenAPI Definition](https://raw.githubusercontent.com/TwineHealth/TwineDeveloperDocs/master/spec/swagger.yaml)
{% admonition type="info" name="OpenAPI specification" %}
For more information on the OpenAPI specification, refer to the [Learning OpenAPI 3](https://redocly.com/docs/resources/learning-openapi/)

Check warning on line 40 in docs/deployment/intro.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/resources/learning-openapi/. 200 - OK
section in the documentation.
{% /admonition %}
Replace `openapi.yaml` in the example command with the file path to your OpenAPI definition.
For more information about the `preview-docs` command, refer to
[Redocly CLI commands](https://redocly.com/docs/cli/commands/preview-docs/#preview-docs) in the Redocly CLI documentation.

Check warning on line 74 in docs/deployment/intro.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/cli/commands/preview-docs/#preview-docs. 200 - OK
#### Python
View file
docs/deployment/react.md
```
For more information on configuration options, refer to the
[Configuration options for Reference docs](https://redocly.com/docs/api-reference-docs/configuration/functionality/)

Check warning on line 64 in docs/deployment/react.md

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/api-reference-docs/configuration/functionality/. 200 - OK
section of the documentation. Options available for Redoc are noted,
"Supported in Redoc CE".