Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-07 13:44:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Trying TOC linebreaks

Browse Source
This commit is contained in:
Swapnil Ogale 2020-09-18 17:07:31 +10:00
parent ca482c072b
commit 057427d05c
1 changed files with 48 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
docs/redoc-vendor-extensions.md
View File

@ -2,57 +2,56 @@
You can use the following [vendor extensions](https://swagger.io/specification/#specificationExtensions) with Redoc.
<!-- MDTOC maxdepth:6 firsth1:1 numbering:0 flatten:0 bullets:1 updateOnSave:1 -->
<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
- [ReDoc vendor extensions](#redoc-vendor-extensions)
- [Swagger Object](#swagger-object)
- [x-servers](#x-servers)
- [x-tagGroups](#x-taggroups)
- [How to use with Redoc](#how-to-use-with-redoc)
- [<a name="tagGroupObject"></a>Tag Group Object](#a-nametaggroupobjectatag-group-object)
- [Fixed fields](#fixed-fields)
- [x-tagGroups example](#x-taggroups-example)
- [x-ignoredHeaderParameters](#x-ignoredheaderparameters)
- [How to use with Redoc](#how-to-use-with-redoc)
- [x-ignoredHeaderParameters example](#x-ignoredheaderparameters-example)
- [Info Object](#info-object)
- [x-logo](#x-logo)
- [How to use with Redoc](#how-to-use-with-redoc)
- [<a name="logoObject"></a>Logo Object](#a-namelogoobjectalogo-object)
- [Fixed fields](#fixed-fields)
- [x-logo example](#x-logo-example)
- [Tag Object](#tag-object)
- [x-traitTag](#x-traittag)
- [How to use with Redoc](#how-to-use-with-redoc)
- [x-traitTag example](#x-traittag-example)
- [x-displayName](#x-displayname)
- [Operation Object vendor extensions](#operation-object-vendor-extensions)
- [x-codeSamples](#x-codesamples)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [<a name="codeSampleObject"></a>Code Sample Object](#a-namecodesampleobjectacode-sample-object)
- [Fixed fields](#fixed-fields)
- [Code Sample Object example](#code-sample-object-example)
- [Parameter Object](#parameter-object)
- [x-examples](#x-examples)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [Response Object vendor extensions](#response-object-vendor-extensions)
- [x-summary](#x-summary)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [Schema Object](#schema-object)
- [x-nullable](#x-nullable)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-extendedDiscriminator](#x-extendeddiscriminator)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-extendedDiscriminator example](#x-extendeddiscriminator-example)
- [x-additionalPropertiesName](#x-additionalpropertiesname)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-additionalPropertiesName example](#x-additionalpropertiesname-example)
- [x-explicitMappingOnly](#x-explicitmappingonly)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-explicitMappingOnly example](#x-explicitmappingonly-example)
<!-- /MDTOC -->
- [ReDoc vendor extensions](#redoc-vendor-extensions)
- [Swagger Object](#swagger-object)
- [x-servers](#x-servers)
- [x-tagGroups](#x-taggroups)
- [How to use with Redoc](#how-to-use-with-redoc)
- [<a name="tagGroupObject"></a>Tag Group Object](#a-nametaggroupobjectatag-group-object)
- [Fixed fields](#fixed-fields)
- [x-tagGroups example](#x-taggroups-example)
- [x-ignoredHeaderParameters](#x-ignoredheaderparameters)
- [How to use with Redoc](#how-to-use-with-redoc)
- [x-ignoredHeaderParameters example](#x-ignoredheaderparameters-example)
- [Info Object](#info-object)
- [x-logo](#x-logo)
- [How to use with Redoc](#how-to-use-with-redoc)
- [<a name="logoObject"></a>Logo Object](#a-namelogoobjectalogo-object)
- [Fixed fields](#fixed-fields)
- [x-logo example](#x-logo-example)
- [Tag Object](#tag-object)
- [x-traitTag](#x-traittag)
- [How to use with Redoc](#how-to-use-with-redoc)
- [x-traitTag example](#x-traittag-example)
- [x-displayName](#x-displayname)
- [Operation Object vendor extensions](#operation-object-vendor-extensions)
- [x-codeSamples](#x-codesamples)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [<a name="codeSampleObject"></a>Code Sample Object](#a-namecodesampleobjectacode-sample-object)
- [Fixed fields](#fixed-fields)
- [Code Sample Object example](#code-sample-object-example)
- [Parameter Object](#parameter-object)
- [x-examples](#x-examples)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [Response Object vendor extensions](#response-object-vendor-extensions)
- [x-summary](#x-summary)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [Schema Object](#schema-object)
- [x-nullable](#x-nullable)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-extendedDiscriminator](#x-extendeddiscriminator)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-extendedDiscriminator example](#x-extendeddiscriminator-example)
- [x-additionalPropertiesName](#x-additionalpropertiesname)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-additionalPropertiesName example](#x-additionalpropertiesname-example)
- [x-explicitMappingOnly](#x-explicitmappingonly)
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-explicitMappingOnly example](#x-explicitmappingonly-example)
<!-- /TOC -->
### Swagger Object
Extends the OpenAPI root [OpenAPI Object](https://swagger.io/specification/#oasObject)