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

Update to TOC

Browse Source
This commit is contained in:
Swapnil Ogale 2020-09-17 14:03:04 +10:00
parent 62156b024f
commit ca482c072b
1 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,7 +2,7 @@
You can use the following [vendor extensions](https://swagger.io/specification/#specificationExtensions) with Redoc.
<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
<!-- MDTOC maxdepth:6 firsth1:1 numbering:0 flatten:0 bullets:1 updateOnSave:1 -->
- [ReDoc vendor extensions](#redoc-vendor-extensions)
- [Swagger Object](#swagger-object)
@ -37,7 +37,7 @@ You can use the following [vendor extensions](https://swagger.io/specification/#
- [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)
- [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)
@ -51,7 +51,7 @@ You can use the following [vendor extensions](https://swagger.io/specification/#
- [How to use with ReDoc](#how-to-use-with-redoc)
- [x-explicitMappingOnly example](#x-explicitmappingonly-example)
<!-- /TOC -->
<!-- /MDTOC -->
### 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