Skip to content

Commit e91c40e

Browse files
committed
Add remote "/docs/redoc/"
remoteId: rem_01jwbtyhn56807p9vb3x9xsskz remoteUpdateId: grupd_01jwbtykd961rvafwymmb5y493 branchName: main commitSha: 3ae251b7e4087091c7837a5cb8bb2914bb8d0eeb commitUrl: Redocly/redoc@3ae251b
1 parent d78bba1 commit e91c40e

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

docs/redoc/redoc-vendor-extensions.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,38 @@ You can use the following [vendor extensions](https://redocly.com/docs/openapi-v
1212
- [x-tagGroups example](#x-taggroups-example)
1313
- [Info Object](#info-object)
1414
- [x-logo](#x-logo)
15-
- [How to use with Redoc](#how-to-use-with-redoc-1)
15+
- [How to use with Redoc](#how-to-use-with-redoc-2)
1616
- [Logo Object](#logo-object)
1717
- [Fixed fields](#fixed-fields-1)
1818
- [x-logo example](#x-logo-example)
1919
- [Tag Object](#tag-object)
2020
- [x-traitTag](#x-traittag)
21-
- [How to use with Redoc](#how-to-use-with-redoc-2)
21+
- [How to use with Redoc](#how-to-use-with-redoc-3)
2222
- [x-traitTag example](#x-traittag-example)
2323
- [x-displayName](#x-displayname)
2424
- [Operation Object vendor extensions](#operation-object-vendor-extensions)
2525
- [x-codeSamples](#x-codesamples)
26-
- [How to use with Redoc](#how-to-use-with-redoc-3)
26+
- [How to use with Redoc](#how-to-use-with-redoc-4)
2727
- [Code Sample Object](#code-sample-object)
2828
- [Fixed fields](#fixed-fields-2)
2929
- [Code Sample Object example](#code-sample-object-example)
30-
- [x-badges](#x-badges)
3130
- [Parameter Object](#parameter-object)
3231
- [x-examples](#x-examples)
33-
- [How to use with Redoc](#how-to-use-with-redoc-4)
32+
- [How to use with Redoc](#how-to-use-with-redoc-5)
3433
- [Response Object vendor extensions](#response-object-vendor-extensions)
3534
- [x-summary](#x-summary)
36-
- [How to use with Redoc](#how-to-use-with-redoc-5)
35+
- [How to use with Redoc](#how-to-use-with-redoc-6)
3736
- [Schema Object](#schema-object)
3837
- [x-nullable](#x-nullable)
39-
- [How to use with Redoc](#how-to-use-with-redoc-6)
40-
- [x-additionalPropertiesName](#x-additionalpropertiesname)
4138
- [How to use with Redoc](#how-to-use-with-redoc-7)
39+
- [x-additionalPropertiesName](#x-additionalpropertiesname)
40+
- [How to use with Redoc](#how-to-use-with-redoc-9)
4241
- [x-additionalPropertiesName example](#x-additionalpropertiesname-example)
4342
- [x-explicitMappingOnly](#x-explicitmappingonly)
44-
- [How to use with Redoc](#how-to-use-with-redoc-8)
43+
- [How to use with Redoc](#how-to-use-with-redoc-10)
4544
- [x-explicitMappingOnly example](#x-explicitmappingonly-example)
4645
- [x-enumDescriptions](#x-enumdescriptions)
47-
- [How to use with Redoc](#how-to-use-with-redoc-9)
46+
- [How to use with Redoc](#how-to-use-with-redoc-11)
4847
- [x-enumDescriptions example](#x-enumdescriptions-example)
4948

5049
## Swagger Object
@@ -68,7 +67,6 @@ Before you use `x-tagGroups`, make sure you **add all tags to a group**, since a
6867
#### Tag Group Object
6968
Information about tags group
7069
##### Fixed fields
71-
7270
| Field Name | Type | Description |
7371
| :---------- | :--------: | :---------- |
7472
| name | string | The group name |
@@ -122,7 +120,6 @@ Extends the OpenAPI [Info Object](https://redocly.com/docs/openapi-visual-refere
122120
The information about API logo
123121

124122
#### Fixed fields
125-
126123
| Field Name | Type | Description |
127124
| :-------------- | :------: | :---------- |
128125
| url | string | The URL pointing to the spec logo. MUST be in the format of a URL. It SHOULD be an absolute URL so your API definition is usable from any location |
@@ -161,7 +158,6 @@ info:
161158
Extends the OpenAPI [Tag Object](https://redocly.com/docs/openapi-visual-reference/tags/)
162159

163160
### x-traitTag
164-
165161
| Field Name | Type | Description |
166162
| :------------- | :------: | :---------- |
167163
| x-traitTag | boolean | In Swagger two operations can have multiple tags. This property distinguishes between tags that are used to group operations (default) from tags that are used to mark operation with certain trait (`true` value) |
@@ -196,7 +192,6 @@ x-traitTag: true
196192
Extends the OpenAPI [Operation Object](https://redocly.com/docs/openapi-visual-reference/operation/)
197193

198194
### x-codeSamples
199-
200195
| Field Name | Type | Description |
201196
| :------------- | :------: | :---------- |
202197
| x-codeSamples | [ [Code Sample Object](#code-sample-object) ] | A list of code samples associated with operation |
@@ -210,7 +205,6 @@ Extends the OpenAPI [Operation Object](https://redocly.com/docs/openapi-visual-r
210205
Operation code sample
211206

212207
#### Fixed fields
213-
214208
| Field Name | Type | Description |
215209
| :---------- | :------: | :----------- |
216210
| lang | string | Code sample language. Value should be one of the following [list](https://github.com/github/linguist/blob/master/lib/linguist/popular.yml) |
@@ -233,7 +227,6 @@ source: console.log('Hello World');
233227
```
234228

235229
### x-badges
236-
237230
| Field Name | Type | Description |
238231
| :------------- | :------: | :---------- |
239232
| 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 |
@@ -242,7 +235,6 @@ source: console.log('Hello World');
242235
Extends the OpenAPI [Parameter Object](https://redocly.com/docs/openapi-visual-reference/parameter/)
243236

244237
### x-examples
245-
246238
| Field Name | Type | Description |
247239
| :------------- | :------: | :---------- |
248240
| 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` |
@@ -254,7 +246,6 @@ Extends the OpenAPI [Parameter Object](https://redocly.com/docs/openapi-visual-r
254246
Extends the OpenAPI [Response Object](https://redocly.com/docs/openapi-visual-reference/response/).
255247

256248
### x-summary
257-
258249
| Field Name | Type | Description |
259250
| :------------- | :------: | :---------- |
260251
| x-summary | string | a short summary of the response |
@@ -266,7 +257,6 @@ If specified, you can use `x-summary` as the response button text, with descript
266257
Extends the OpenAPI [Schema Object](https://redocly.com/docs/openapi-visual-reference/schemas/)
267258

268259
### x-nullable
269-
270260
| Field Name | Type | Description |
271261
| :------------- | :------: | :---------- |
272262
| x-nullable | boolean | marks schema as a nullable |
@@ -335,7 +325,6 @@ Pet:
335325
Shows in the selectpicker only the items `cat` and `bee`, even though the `Dog` class inherits from the `Pet` class.
336326

337327
### x-enumDescriptions
338-
339328
| Field Name | Type | Description |
340329
| :------------- | :------: | :---------- |
341330
| x-enumDescriptions | [[Enum Description Object](https://redocly.com/docs/realm/author/reference/openapi-extensions/x-enum-descriptions#enum-description-object)] | A list of the enum values and descriptions to include in the documentation. |

0 commit comments

Comments
 (0)