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.

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

docs: update broken link of Openapi Object #2577

Merged
merged 1 commit into from
Aug 29, 2024
Merged
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/redoc-vendor-extensions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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

View workflow job for this annotation

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)
Expand Down Expand Up @@ -50,10 +50,10 @@
- [x-explicitMappingOnly example](#x-explicitmappingonly-example)

## Swagger Object
Extends the OpenAPI root [OpenAPI Object](https://redocly.com/docs/openapi-visual-reference/openapi-1/)
Extends the OpenAPI root [OpenAPI Object](https://redocly.com/docs/openapi-visual-reference/openapi)

### x-servers
Backported from OpenAPI 3.0 [`servers`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#serverObject). Currently doesn't support templates.

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

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning


### x-tagGroups

Expand Down Expand Up @@ -233,7 +233,7 @@
#### 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 236 in docs/redoc-vendor-extensions.md

View workflow job for this annotation

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 |

Expand All @@ -258,13 +258,13 @@
### x-examples
| Field Name | Type | Description |
| :------------- | :------: | :---------- |
| x-examples | [Example Object](https://redocly.com/docs/openapi-visual-reference/example/) | Object that contains examples for the request. Applies when `in` is `body` and mime-type is `application/json` |

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

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning

https://redocly.com/docs/openapi-visual-reference/example/. 200 - OK

#### How to use with Redoc
`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 267 in docs/redoc-vendor-extensions.md

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning

https://redocly.com/docs/openapi-visual-reference/response/. 200 - OK

### x-summary
| Field Name | Type | Description |
Expand Down
Loading