{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"redoc-ce-vendor-extensions","__idx":0},"children":["Redoc CE vendor extensions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the following ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/specification-extensions/"},"children":["vendor extensions"]}," with Redoc CE."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"swagger-object","__idx":1},"children":["Swagger Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the OpenAPI root ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/openapi"},"children":["OpenAPI Object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-servers","__idx":2},"children":["x-servers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Backported from OpenAPI 3.0 ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#server-object"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["servers"]}]},"."," ","Currently doesn't support templates."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-taggroups","__idx":3},"children":["x-tagGroups"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-tagGroups"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#tag-group-object"},"children":["Tag Group Object"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A list of tag groups"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-taggroups-with-redoc-ce","__idx":4},"children":["Use x-tagGroups with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-tagGroups"]}," is used to group tags in the side menu."," ","Before you use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-tagGroups"]},", make sure you ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["add all tags to a group"]},"."," ","A tag that is not in a group ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["is not displayed"]}," at all!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"name":"tagGroupObject"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"tag-group-object","__idx":5},"children":["Tag Group Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Information about tags group"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"fixed-fields","__idx":6},"children":["Fixed fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The group name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["tags"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of tags to include in this group"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"x-taggroups-example","__idx":7},"children":["x-tagGroups example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"JSON","header":{"title":"JSON","controls":{"copy":{}}},"source":"{\n  \"x-tagGroups\": [\n    {\n      \"name\": \"User Management\",\n      \"tags\": [\"Users\", \"API keys\", \"Admin\"]\n    },\n    {\n      \"name\": \"Statistics\",\n      \"tags\": [\"Main Stats\", \"Secondary Stats\"]\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["yaml"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"x-tagGroups:\n  - name: User Management\n    tags:\n      - Users\n      - API keys\n      - Admin\n  - name: Statistics\n    tags:\n      - Main Stats\n      - Secondary Stats\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"info-object","__idx":8},"children":["Info Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the OpenAPI ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/info/"},"children":["Info Object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-logo","__idx":9},"children":["x-logo"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-logo"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#logo-object"},"children":["Logo Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The configuration for the logo that appears on the API's documentation pages."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-logo-with-redoc-ce","__idx":10},"children":["Use x-logo with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-logo"]}," is used to specify API logo."," ","The corresponding image is displayed just above the side-menu."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"name":"logoObject"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"logo-object","__idx":11},"children":["Logo Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The information about API logo"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"fixed-fields-1","__idx":12},"children":["Fixed fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["url"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The URL pointing to the logo image that appears on the API's documentation pages."," ","MUST be in the format of a URL."," ","To make the API description file usable from any location, use a an absolute URL."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["backgroundColor"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Background color for the image."," ","MUST be an RGB color in ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://en.wikipedia.org/wiki/Web_colors#Hex_triplet"},"children":["hexadecimal format"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["altText"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text to use for the logo's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alt"]}," tag."," ","Defaults to 'logo' if nothing is provided."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["href"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The URL pointing to the contact page."," ","Default to 'info.contact.url' field of the OAS."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"x-logo-example","__idx":13},"children":["x-logo example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"JSON","header":{"title":"JSON","controls":{"copy":{}}},"source":"{\n  \"info\": {\n    \"version\": \"1.0.0\",\n    \"title\": \"Swagger Petstore\",\n    \"x-logo\": {\n      \"url\": \"https://redocly.github.io/redoc/petstore-logo.png\",\n      \"backgroundColor\": \"#FFFFFF\",\n      \"altText\": \"Petstore logo\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"YAML","header":{"title":"YAML","controls":{"copy":{}}},"source":"info:\n  version: \"1.0.0\"\n  title: \"Swagger Petstore\"\n  x-logo:\n    url: \"https://redocly.github.io/redoc/petstore-logo.png\"\n    backgroundColor: \"#FFFFFF\"\n    altText: \"Petstore logo\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tag-object","__idx":14},"children":["Tag Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the OpenAPI ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/tags/"},"children":["Tag Object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-traittag","__idx":15},"children":["x-traitTag"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-traitTag"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["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 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," value)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-traittag-with-redoc-ce","__idx":16},"children":["Use x-traitTag with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tags that have ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-traitTag"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," are listed in the side-menu but don't have any subitems (operations)."," ","It also renders the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," tag."," ","This is useful for handling out common things like Pagination, Rate-Limits, etc."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"x-traittag-example","__idx":17},"children":["x-traitTag example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"JSON","header":{"title":"JSON","controls":{"copy":{}}},"source":"{\n    \"name\": \"Pagination\",\n    \"description\": \"Pagination description (can use markdown syntax)\",\n    \"x-traitTag\": true\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"YAML","header":{"title":"YAML","controls":{"copy":{}}},"source":"name: Pagination\ndescription: Pagination description (can use markdown syntax)\nx-traitTag: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-displayname","__idx":18},"children":["x-displayName"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-displayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines the text that is used for this tag in the menu and in section headings"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"operation-object-vendor-extensions","__idx":19},"children":["Operation Object vendor extensions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the OpenAPI ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/operation/"},"children":["Operation Object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-codesamples","__idx":20},"children":["x-codeSamples"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-codeSamples"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#code-sample-object"},"children":["Code Sample Object"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A list of code samples associated with operation"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-codesamples-with-redoc-ce","__idx":21},"children":["Use x-codeSamples with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-codeSamples"]}," are rendered on the right panel in Redoc CE."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"name":"codeSampleObject"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"code-sample-object","__idx":22},"children":["Code Sample Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Operation code sample"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"fixed-fields-2","__idx":23},"children":["Fixed fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["lang"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Code sample language."," ","Value should be one of the following ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.com/github/linguist/blob/master/lib/linguist/popular.yml"},"children":["list"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Code sample label, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Node"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Python2.7"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["optional"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lang"]}," is used by default"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["source"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Code sample source code"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"code-sample-object-example","__idx":24},"children":["Code Sample Object example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"JSON","header":{"title":"JSON","controls":{"copy":{}}},"source":"{\n  \"lang\": \"JavaScript\",\n  \"source\": \"console.log('Hello World');\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"YAML","header":{"title":"YAML","controls":{"copy":{}}},"source":"lang: JavaScript\nsource: console.log('Hello World');\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-badges","__idx":25},"children":["x-badges"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-badges"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/author/reference/openapi-extensions/x-badges#badge-object"},"children":["Badge Object"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A list of badges associated with the operation"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"parameter-object","__idx":26},"children":["Parameter Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the OpenAPI ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/parameter/"},"children":["Parameter Object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-examples","__idx":27},"children":["x-examples"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-examples"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/example/"},"children":["Example Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object that contains examples for the request."," ","Applies when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["in"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["body"]}," and mime-type is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-examples-with-redoc-ce","__idx":28},"children":["Use x-examples with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-examples"]}," are rendered in the JSON tab on the right panel in Redoc CE."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-object-vendor-extensions","__idx":29},"children":["Response Object vendor extensions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the OpenAPI ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/response/"},"children":["Response Object"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-summary","__idx":30},"children":["x-summary"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-summary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["a short summary of the response"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-summary-with-redoc-ce","__idx":31},"children":["Use x-summary with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If specified, you can use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-summary"]}," as the response button text, with description rendered under the button."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"schema-object","__idx":32},"children":["Schema Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the OpenAPI ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/schemas/"},"children":["Schema Object"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-nullable","__idx":33},"children":["x-nullable"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-nullable"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["marks schema as a nullable"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-nullable-with-redoc-ce","__idx":34},"children":["Use x-nullable with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schemas marked as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-nullable"]}," are marked in Redoc CE with the label Nullable."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-additionalpropertiesname","__idx":35},"children":["x-additionalPropertiesName"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-additionalPropertiesName"]}," is a Redoc CE-specific vendor extension, and is not supported by other tools."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalProperties"]}," property of the schema object."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-additionalPropertiesName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["descriptive name of additional properties keys"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-additionalpropertiesname-with-redoc-ce","__idx":36},"children":["Use x-additionalPropertiesName with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redoc CE uses this extension to display a more descriptive property name in objects with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalProperties"]}," when viewing the property list with an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"x-additionalpropertiesname-example","__idx":37},"children":["x-additionalPropertiesName example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"Player:\n  required:\n  - name\n\n  properties:\n    name:\n      type: string\n\n  additionalProperties:\n    x-additionalPropertiesName: attribute-name\n    type: string\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-explicitmappingonly","__idx":38},"children":["x-explicitMappingOnly"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-explicitMappingOnly"]}," is a Redoc CE-specific vendor extension, and is not supported by other tools."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Extends the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discriminator"]}," property of the schema object."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-explicitMappingOnly"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["limit the discriminator selectpicker to the explicit mappings only"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-explicitmappingonly-with-redoc-ce","__idx":39},"children":["Use x-explicitMappingOnly with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redoc CE uses this extension to filter the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discriminator"]}," mappings shown in the selectpicker."," ","When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", the selectpicker lists only the explicitly defined mappings."," ","When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", the default behavior is kept, in other words, explicit and implicit mappings are shown."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"x-explicitmappingonly-example","__idx":40},"children":["x-explicitMappingOnly example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"Pet:\n  type: object\n  required:\n    - name\n    - photoUrls\n  discriminator:\n    propertyName: petType\n    x-explicitMappingOnly: true\n    mapping:\n      cat: \"#/components/schemas/Cat\"\n      bee: \"#/components/schemas/HoneyBee\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Shows in the selectpicker only the items ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cat"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bee"]},", even though the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dog"]}," class inherits from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Pet"]}," class."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"x-enumdescriptions","__idx":41},"children":["x-enumDescriptions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-enumDescriptions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/author/reference/openapi-extensions/x-enum-descriptions#enum-description-object"},"children":["Enum Description Object"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A list of the enum values and descriptions to include in the documentation."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"use-x-enumdescriptions-with-redoc-ce","__idx":42},"children":["Use x-enumDescriptions with Redoc CE"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The enum (short for \"enumeration\") fields in OpenAPI allow you to restrict the value of a field to a list of allowed values."," ","These values need to be short and machine-readable, but that can make them harder for humans to parse and work with."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-enumDescriptions"]}," to your OpenAPI description to show a helpful table of enum options and an explanation of what each one means."," ","This field supports Markdown."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"x-enumdescriptions-example","__idx":43},"children":["x-enumDescriptions example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows a schema with two short-named options, and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-enumDescriptions"]}," entry to list all enum entries and give additional context for each:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"components:\n  schemas:\n    TicketType:\n      description: Type of ticket being purchased.\n      Use `general` for regular museum entry and `event` for tickets to special events.\n      type: string\n      enum:\n        - event\n        - general\n      x-enumDescriptions:\n        event: Event Tickets _(timed entry)_\n        general: General Admission\n      example: event\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":44},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/redoc/v2.x/config"},"children":["Configure Redoc CE"]}]}," - Explore Redoc CE's configuration options"]}]}]},"frontmatter":{},"tagList":["admonition","html","table"],"title":"Redoc CE vendor extensions","lastModified":"2026-08-24T16:23:25.000Z"}