Skip to content

Commit ce27184

Browse files
RomanHotsiyRomanHotsiy
committed
fix: fix headin slugs
1 parent 3ae251b commit ce27184

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

‎docs/redoc-vendor-extensions.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,39 @@ 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-2)
15+
- [How to use with Redoc](#how-to-use-with-redoc-1)
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-3)
21+
- [How to use with Redoc](#how-to-use-with-redoc-2)
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-4)
26+
- [How to use with Redoc](#how-to-use-with-redoc-3)
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)
3031
- [Parameter Object](#parameter-object)
3132
- [x-examples](#x-examples)
32-
- [How to use with Redoc](#how-to-use-with-redoc-5)
33+
- [How to use with Redoc](#how-to-use-with-redoc-4)
3334
- [Response Object vendor extensions](#response-object-vendor-extensions)
3435
- [x-summary](#x-summary)
35-
- [How to use with Redoc](#how-to-use-with-redoc-6)
36+
- [How to use with Redoc](#how-to-use-with-redoc-5)
3637
- [Schema Object](#schema-object)
3738
- [x-nullable](#x-nullable)
38-
- [How to use with Redoc](#how-to-use-with-redoc-7)
39+
- [How to use with Redoc](#how-to-use-with-redoc-6)
3940
- [x-additionalPropertiesName](#x-additionalpropertiesname)
40-
- [How to use with Redoc](#how-to-use-with-redoc-9)
41+
- [How to use with Redoc](#how-to-use-with-redoc-7)
4142
- [x-additionalPropertiesName example](#x-additionalpropertiesname-example)
4243
- [x-explicitMappingOnly](#x-explicitmappingonly)
43-
- [How to use with Redoc](#how-to-use-with-redoc-10)
44+
- [How to use with Redoc](#how-to-use-with-redoc-8)
4445
- [x-explicitMappingOnly example](#x-explicitmappingonly-example)
4546
- [x-enumDescriptions](#x-enumdescriptions)
46-
- [How to use with Redoc](#how-to-use-with-redoc-11)
47+
- [How to use with Redoc](#how-to-use-with-redoc-9)
4748
- [x-enumDescriptions example](#x-enumdescriptions-example)
4849

4950
## Swagger Object
@@ -67,6 +68,7 @@ Before you use `x-tagGroups`, make sure you **add all tags to a group**, since a
6768
#### Tag Group Object
6869
Information about tags group
6970
##### Fixed fields
71+
7072
| Field Name | Type | Description |
7173
| :---------- | :--------: | :---------- |
7274
| name | string | The group name |
@@ -120,6 +122,7 @@ Extends the OpenAPI [Info Object](https://redocly.com/docs/openapi-visual-refere
120122
The information about API logo
121123

122124
#### Fixed fields
125+
123126
| Field Name | Type | Description |
124127
| :-------------- | :------: | :---------- |
125128
| 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 |
@@ -158,6 +161,7 @@ info:
158161
Extends the OpenAPI [Tag Object](https://redocly.com/docs/openapi-visual-reference/tags/)
159162

160163
### x-traitTag
164+
161165
| Field Name | Type | Description |
162166
| :------------- | :------: | :---------- |
163167
| 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) |
@@ -192,6 +196,7 @@ x-traitTag: true
192196
Extends the OpenAPI [Operation Object](https://redocly.com/docs/openapi-visual-reference/operation/)
193197

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

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

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

237244
### x-examples
245+
238246
| Field Name | Type | Description |
239247
| :------------- | :------: | :---------- |
240248
| 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` |
@@ -246,6 +254,7 @@ Extends the OpenAPI [Parameter Object](https://redocly.com/docs/openapi-visual-r
246254
Extends the OpenAPI [Response Object](https://redocly.com/docs/openapi-visual-reference/response/).
247255

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

259268
### x-nullable
269+
260270
| Field Name | Type | Description |
261271
| :------------- | :------: | :---------- |
262272
| x-nullable | boolean | marks schema as a nullable |
@@ -325,6 +335,7 @@ Pet:
325335
Shows in the selectpicker only the items `cat` and `bee`, even though the `Dog` class inherits from the `Pet` class.
326336

327337
### x-enumDescriptions
338+
328339
| Field Name | Type | Description |
329340
| :------------- | :------: | :---------- |
330341
| 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. |
@@ -350,4 +361,4 @@ components:
350361
event: Event Tickets _(timed entry)_
351362
general: General Admission
352363
example: event
353-
```
364+
```

0 commit comments

Comments
 (0)