From ca482c072ba933c34994ba69a13fd9128ff7b42f Mon Sep 17 00:00:00 2001 From: Swapnil Ogale Date: Thu, 17 Sep 2020 14:03:04 +1000 Subject: [PATCH] Update to TOC --- docs/redoc-vendor-extensions.md | 98 ++++++++++++++++----------------- 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/redoc-vendor-extensions.md b/docs/redoc-vendor-extensions.md index 1756c519..ae17cb9c 100644 --- a/docs/redoc-vendor-extensions.md +++ b/docs/redoc-vendor-extensions.md @@ -2,56 +2,56 @@ You can use the following [vendor extensions](https://swagger.io/specification/#specificationExtensions) with Redoc. - + -- [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) - - [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) - - [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) - - [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) - - [Usage in ReDoc](#usage-in-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) +- [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) + - [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) + - [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) + - [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) - + ### Swagger Object Extends the OpenAPI root [OpenAPI Object](https://swagger.io/specification/#oasObject) @@ -268,7 +268,7 @@ Extends the OpenAPI [Response Object](https://swagger.io/specification/#response | :------------- | :------: | :---------- | | x-summary | string | a short summary of the response | -###### Usage in ReDoc +###### How to use with ReDoc If specified, you can use `x-summary` as the response button text, with description rendered under the button. ### Schema Object