{"_id":"@benmarch/redoc","name":"@benmarch/redoc","dist-tags":{"latest":"2.0.0"},"versions":{"2.0.0":{"name":"@benmarch/redoc","version":"2.0.0","description":"ReDoc","repository":{"type":"git","url":"git://github.com/Redocly/redoc.git"},"browserslist":["defaults"],"engines":{"node":">=6.9","npm":">=3.0.0"},"author":{"name":"Roman Hotsiy","email":"gotsijroman@gmail.com"},"license":"MIT","keywords":["OpenAPI","OpenAPI Specification","Swagger","JSON-Schema","API","REST","documentation","React.js"],"main":"bundles/redoc.lib.js","browser":"bundles/redoc.browser.lib.js","types":"typings/index.d.ts","scripts":{"start":"webpack serve --mode=development --env playground --hot --config demo/webpack.config.ts","start:prod":"webpack serve --env playground --mode=production --config demo/webpack.config.ts","start:benchmark":"webpack serve --mode=production --env.bench --config demo/webpack.config.ts","test":"npm run unit && npm run license-check","unit":"jest --coverage","test:update-snapshot":"jest --updateSnapshot","e2e":"cypress run","e2e-ci":"cypress run --record","bundlesize":"size-limit","ts-check":"tsc --noEmit --skipLibCheck","cy:open":"cypress open","bundle:clean":"rimraf bundles","bundle:standalone":"webpack --env production --env standalone --mode=production","bundle:lib":"webpack --mode=production && npm run declarations","bundle:browser":"webpack --env production --env browser --mode=production","bundle":"npm run bundle:clean && npm run bundle:lib && npm run bundle:browser && npm run bundle:standalone && npm run compile:cli","declarations":"tsc --emitDeclarationOnly -p tsconfig.lib.json && cp -R src/types typings/","stats":"webpack --env production --env standalone --json --profile --mode=production > stats.json","prettier":"prettier --write \"cli/index.ts\" \"src/**/*.{ts,tsx}\"","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 1","lint":"eslint --fix 'src/**/*.{js,ts,tsx}' --cache","benchmark":"node ./benchmark/benchmark.js","start:demo":"webpack serve --hot --config demo/webpack.config.ts --mode=development","compile:cli":"tsc custom.d.ts cli/index.ts --target es6 --module commonjs --types yargs","build:demo":"webpack --mode=production --config demo/webpack.config.ts","publish-cdn":"scripts/publish-cdn.sh","deploy:demo":"aws s3 sync demo/dist s3://production-redoc-demo --acl=public-read","license-check":"license-checker --production --onlyAllow 'MIT;ISC;Apache-2.0;BSD;BSD-2-Clause;BSD-3-Clause;CC-BY-4.0;Python-2.0' --summary","docker:build":"docker build -f config/docker/Dockerfile -t redoc .","prepare":"husky install","pre-commit":"pretty-quick --staged && npm run lint"},"devDependencies":{"@cypress/webpack-preprocessor":"^5.12.0","@hot-loader/react-dom":"^17.0.2","@size-limit/preset-app":"^7.0.4","@types/chai":"^4.2.18","@types/dompurify":"^2.2.2","@types/enzyme":"^3.10.5","@types/enzyme-to-json":"^1.5.3","@types/jest":"^26.0.23","@types/json-pointer":"^1.0.30","@types/lunr":"^2.3.3","@types/mark.js":"^8.11.5","@types/marked":"^4.0.3","@types/node":"^15.6.1","@types/prismjs":"^1.16.5","@types/prop-types":"^15.7.3","@types/react":"^17.0.8","@types/react-dom":"^17.0.5","@types/react-tabs":"^2.3.2","@types/styled-components":"^5.1.1","@types/tapable":"^2.2.2","@types/webpack":"^5.28.0","@types/webpack-env":"^1.16.0","@types/yargs":"^17.0.0","@typescript-eslint/eslint-plugin":"^4.26.0","@typescript-eslint/parser":"^4.26.0","@wojtekmaj/enzyme-adapter-react-17":"^0.6.1","beautify-benchmark":"^0.2.4","conventional-changelog-cli":"^2.0.34","copy-webpack-plugin":"^9.0.0","core-js":"^3.13.1","coveralls":"^3.1.0","css-loader":"^5.2.6","cypress":"^7.4.0","enzyme":"^3.11.0","enzyme-to-json":"^3.6.2","esbuild-loader":"^2.18.0","eslint":"^7.27.0","eslint-plugin-import":"^2.23.4","eslint-plugin-react":"^7.25.1","eslint-plugin-react-hooks":"^4.2.0","fork-ts-checker-webpack-plugin":"^6.2.10","html-webpack-plugin":"^5.3.1","husky":"^7.0.0","jest":"^27.0.3","js-yaml":"^4.1.0","license-checker":"^25.0.1","lodash.noop":"^3.0.1","mobx":"^6.3.2","outdent":"^0.8.0","prettier":"^2.3.2","pretty-quick":"^3.0.0","raf":"^3.4.1","react":"^17.0.2","react-dom":"^17.0.2","react-hot-loader":"^4.13.0","rimraf":"^3.0.2","shelljs":"^0.8.4","size-limit":"^7.0.4","styled-components":"^5.3.0","ts-jest":"^27.0.2","ts-loader":"^9.2.6","ts-node":"^10.0.0","tslib":"^2.4.0","typescript":"~4.1.0","unfetch":"^4.2.0","webpack":"^5.50.1","webpack-cli":"^4.7.2","webpack-dev-server":"^4.6.0","webpack-node-externals":"^3.0.0","workerize-loader":"github:redocly/workerize-loader#webpack-5-dist"},"peerDependencies":{"core-js":"^3.1.4","mobx":"^6.0.4","react":"^16.8.4 || ^17.0.0 || ^18.0.0","react-dom":"^16.8.4 || ^17.0.0 || ^18.0.0","styled-components":"^4.1.1 || ^5.1.1"},"dependencies":{"@redocly/openapi-core":"^1.0.0-beta.104","classnames":"^2.3.1","decko":"^1.2.0","dompurify":"^2.2.8","eventemitter3":"^4.0.7","json-pointer":"^0.6.2","lunr":"^2.3.9","mark.js":"^8.11.1","marked":"^4.0.15","mobx-react":"^7.2.0","openapi-sampler":"^1.3.0","path-browserify":"^1.0.1","perfect-scrollbar":"^1.5.5","polished":"^4.1.3","prismjs":"^1.27.0","prop-types":"^15.7.2","react-tabs":"^3.2.2","slugify":"~1.4.7","stickyfill":"^1.1.1","style-loader":"^3.3.1","swagger2openapi":"^7.0.6","url-template":"^2.0.8"},"size-limit":[{"path":"./bundles/redoc.standalone.js","limit":"350 kB"},{"path":"./bundles/redoc.lib.js","limit":"100 kB"},{"path":"./bundles/redoc.browser.lib.js","limit":"100 kB"}],"jest":{"testEnvironment":"jsdom","setupFilesAfterEnv":["<rootDir>/src/setupTests.ts"],"preset":"ts-jest","collectCoverageFrom":["src/**/*.{ts,tsx}"],"coverageReporters":["json","lcov","text-summary"],"coveragePathIgnorePatterns":["\\.d\\.ts$","/benchmark/","/node_modules/","src/services/__tests__/models/helpers.ts"],"modulePathIgnorePatterns":["/benchmark/","src/services/__tests__/models/helpers.ts"],"snapshotSerializers":["enzyme-to-json/serializer"],"moduleNameMapper":{"\\.(css|less)$":"<rootDir>/src/empty.js"}},"prettier":{"singleQuote":true,"trailingComma":"all","printWidth":100,"arrowParens":"avoid"},"gitHead":"c052a901ebad024a3f5c15bdefde7fbd9b51f039","bugs":{"url":"https://github.com/Redocly/redoc/issues"},"homepage":"https://github.com/Redocly/redoc#readme","_id":"@benmarch/redoc@2.0.0","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-6eKmsqrIo7Ep21mRtpb1Hr8XtggnyiFXMEZYpMqlS2ynZh8CWOpsQWu/Xl/l2H3r64YJfbzybmCp46oIexz2Wg==","shasum":"c55c01cda2b6b0076a7435159eb5728051316f52","tarball":"https://registry.npmjs.org/@benmarch/redoc/-/redoc-2.0.0.tgz","fileCount":174,"unpackedSize":7524034,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDME5I7eG6GVOObf2qfNsF6yNsY/nXFGHGwkgIQaOoIPQIgPtaunty4EDpiVUawglA3biNVVP79kHMU/1e72oVl79w="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkC79YACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr58g/9GLxL6RZEkAcrIM0gRM6DIieEu4svBcJW2QtrBqXRZ64ZoTbh\r\nG/fGIYbiaCTFTT9ss9qnzgSez0RaoyEwoIYBWp+q42S6ehDcwMMHUI+8Thhr\r\nRnQjnbLbtQbYtKDH4yfEmjobRlyREVm9kceSNG5Dzii4+ZnoR5IMiCJKIvSw\r\nib/r4feHqDw3P1UHLFrXY5ypbSKmQohT+SjkXMBmT5KPBbvbNKIDthsEFXM7\r\nOAlMQwS9vT+jQ42/5nQ9s1S/88vvUj5izxKQDoveOwEXAd2DU0hKMXmw4BH8\r\n4KsX9A/AH91+dKp5j9awmBHSdM70bS9XQbNC8gP4C2VxjK8UVojbYTHYjBXy\r\nOabOHQxltovPBKnBWipy3KP8phw83nojTbg6s50efD5QCmD0CWCins+Gvziu\r\nR7HeCTG5Nn7oEQSOKvOs34FdlZ+G3ugYfco7QNYhy7D069kapda7sZOxuqCN\r\nH+wiv3SLF10c8RWcLogR0hVrx2ATlLCN0JG1zIsMdvauJ9eAMF8gNPNIZ1x/\r\niOE/1OfykNMCTj0tW7QclVqTAZjto/4SH3Ds2kuYxaPAKij0FT274f8qrSyO\r\nAiMx0ZflgtZvGht0exTV3/EEj3nIk5iEfUZJuzb93/LWZv1QlS4ZgZdco1eq\r\nXlZCIIR8batl/a5KYtIrD6Laedu31CbN+X0=\r\n=LSqz\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"benmarch","email":"bmarch89@gmail.com"},"directories":{},"maintainers":[{"name":"benmarch","email":"bmarch89@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/redoc_2.0.0_1678491480704_0.5558678307261233"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-10T23:38:00.637Z","2.0.0":"2023-03-10T23:38:00.950Z","modified":"2023-03-10T23:38:01.170Z"},"maintainers":[{"name":"benmarch","email":"bmarch89@gmail.com"}],"description":"ReDoc","homepage":"https://github.com/Redocly/redoc#readme","keywords":["OpenAPI","OpenAPI Specification","Swagger","JSON-Schema","API","REST","documentation","React.js"],"repository":{"type":"git","url":"git://github.com/Redocly/redoc.git"},"author":{"name":"Roman Hotsiy","email":"gotsijroman@gmail.com"},"bugs":{"url":"https://github.com/Redocly/redoc/issues"},"license":"MIT","readme":"<div align=\"center\">\n  <img alt=\"Redoc logo\" src=\"https://raw.githubusercontent.com/Redocly/redoc/main//docs/images/redoc.png\" width=\"400px\" />\n\n  # Generate interactive API documentation from OpenAPI definitions\n\n  [![Coverage Status](https://coveralls.io/repos/Redocly/redoc/badge.svg?branch=main&service=github)](https://coveralls.io/github/Redocly/redoc?branch=main) [![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/main/LICENSE)\n\n  [![bundle size](http://img.badgesize.io/https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js?compression=gzip&max=300000)](https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js) [![npm](https://img.shields.io/npm/dm/redoc.svg)](https://www.npmjs.com/package/redoc) [![](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc) [![Docker Build Status](https://img.shields.io/docker/build/redocly/redoc.svg)](https://hub.docker.com/r/redocly/redoc/)\n</div>\n\n**This is the README for the `2.x` version of Redoc (React-based).**\n**The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch.**\n\n## About Redoc\n\nRedoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.\n\nBy default Redoc offers a three-panel, responsive layout:\n\n- The left panel contains a search bar and navigation menu.\n- The central panel contains the documentation.\n- The right panel contains request and response examples.\n\n![Redoc demo](https://raw.githubusercontent.com/Redocly/redoc/main/demo/redoc-demo.png)\n\n## Live demo\n\nIf you want to see how Redoc will render your OpenAPI definition,\nyou can try it out online at https://redocly.github.io/redoc/.\n\nA version of the Swagger Petstore API is displayed by default.\nTo test it with your own OpenAPI definition,\nenter the URL for your definition and select **TRY IT**.\n\n## Redoc vs. Reference vs. Portals\n\nRedoc is Redocly's community-edition product. Looking for something more?\nCheckout the following feature comparison of Redocly's premium products versus Redoc:\n\n| Features                     | Redoc     | Reference | Portals     |\n|------------------------------|:---------:|:---------:|:-----------:|\n| **Specs**                    |           |           |             |\n| Swagger 2.0                  | √         | √         | √           |\n| OpenAPI 3.0                  | √         | √         | √           |\n| OpenAPI 3.1                  | √ (basic) | √         | √           |\n|                              |           |           |             |\n| **Theming**                  |           |           |             |\n| Fonts/colors                 | √         | √         | √           |\n| Extra theme options          |           | √         | √           |\n|                              |           |           |             |\n| **Performance**              |           |           |             |\n| Pagination                   |           | √         | √           |\n| Search (enhanced)            |           | √         | √           |\n| Search (server-side)         |           |           | √           |\n|                              |           |           |             |\n| **Multiple APIs**            |           |           |             |\n| Multiple versions            |           | √         | √           |\n| Multiple APIs                |           |           | √           |\n| API catalog                  |           |           | √           |\n|                              |           |           |             |\n| **Additional features**      |           |           |             |\n| Try-it console               |           | √         | √           |\n| Automated code samples       |           | √         | √           |\n| Deep links                   |           | √         | √           |\n| More SEO control             |           |           | √           |\n| Contextual docs              |           |           | √           |\n| Landing pages                |           |           | √           |\n| React hooks for more control |           |           | √           |\n| Personalization              |           |           | √           |\n| Analytics integrations       |           |           | √           |\n| Feedback                     |           |           | Coming Soon |\n\nRefer to the Redocly's documentation for more information on these products:\n\n- [Portals](https://redocly.com/docs/developer-portal/introduction/)\n- [Reference](https://redocly.com/docs/api-reference-docs/getting-started/)\n- [Redoc](https://redocly.com/docs/redoc/quickstart/intro/)\n\n## Features\n- Responsive three-panel design with menu/scrolling synchronization\n- [Multiple deployment options](https://redocly.com/docs/redoc/quickstart/intro/)\n- [Server-side rendering (SSR) ready](https://redocly.com/docs/redoc/quickstart/cli/#redoc-cli-commands)\n- Ability to integrate your API introduction into the side menu\n- [Simple integration with `create-react-app`](https://redocly.com/docs/redoc/quickstart/react/)\n\n  [Example repo](https://github.com/APIs-guru/create-react-app-redoc)\n- [Command-line interface to bundle your docs into a **zero-dependency** HTML file](https://redocly.com/docs/cli/commands/build-docs/)\n- Neat **interactive** documentation for nested objects <br>\n  ![](docs/images/nested-demo.gif)\n\n## Customization options\n[<img alt=\"Customization services\" src=\"http://i.imgur.com/c4sUF7M.png\" height=\"60px\">](https://redocly.com/#services)\n- High-level grouping in side-menu with the [`x-tagGroups`](https://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension\n- Branding/customizations using the [`theme` option](https://redocly.com/docs/api-reference-docs/configuration/theming/)\n\n## Support\n- OpenAPI v3.0 support\n- Basic OpenAPI v3.1 support\n- Broad OpenAPI v2.0 feature support (yes, it supports even `discriminator`) <br>\n  ![](docs/images/discriminator-demo.gif)\n- Code samples support (via vendor extension) <br>\n  ![](docs/images/code-samples-demo.gif)\n\n## Releases\n**Important:** all the 2.x releases are deployed to npm and can be used with Redocly-cdn:\n- particular release, for example, `v2.0.0`: https://cdn.redoc.ly/redoc/v2.0.0/bundles/redoc.standalone.js\n- `latest` release: https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\n\nAdditionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**:\n- particular release, for example `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js\n- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js\n- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js - it will point to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.\n\n## Version Guidance\n| Redoc Release | OpenAPI Specification |\n|:--------------|:----------------------|\n| 2.0.0-alpha.54| 3.1, 3.0.x, 2.0       |\n| 2.0.0-alpha.x | 3.0, 2.0              |\n| 1.19.x        | 2.0                   |\n| 1.18.x        | 2.0                   |\n| 1.17.x        | 2.0                   |\n\n## Showcase\n- [Rebilly](https://api-reference.rebilly.com/)\n- [Docker Engine](https://docs.docker.com/engine/api/v1.25/)\n- [Zuora](https://www.zuora.com/developer/api-reference/)\n- [Discourse](http://docs.discourse.org)\n- [Commbox](https://www.commbox.io/api/)\n- [APIs.guru](https://apis.guru/api-doc/)\n- [BoxKnight](https://www.docs.boxknight.com/)\n\n## Lint OpenAPI definitions\n\nRedocly's CLI is an [open source command-line tool](https://github.com/Redocly/redocly-cli) that you can use to lint\nyour OpenAPI definition. Linting helps you to catch errors and inconsistencies in your\nOpenAPI definition before publishing.\n\nRefer to [Redocly configuration](https://redocly.com/docs/cli/configuration/) in the OpenAPI documentation for more information.\n\n## Deployment\n\n### TL;DR final code example\n\nTo render your OpenAPI definition using Redoc, use the following HTML code sample and\nreplace the `spec-url` attribute with the url or local file address to your definition.\n\n```html\n<!DOCTYPE html>\n<html>\n  <head>\n    <title>Redoc</title>\n    <!-- needed for adaptive design -->\n    <meta charset=\"utf-8\"/>\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n    <link href=\"https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700\" rel=\"stylesheet\">\n\n    <!--\n    Redoc doesn't change outer page styles\n    -->\n    <style>\n      body {\n        margin: 0;\n        padding: 0;\n      }\n    </style>\n  </head>\n  <body>\n    <redoc spec-url='http://petstore.swagger.io/v2/swagger.json'></redoc>\n    <script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"> </script>\n  </body>\n</html>\n\n```\n\nFor step-by-step instructions for how to get started using Redoc\nto render your OpenAPI definition, refer to the\n[**Redoc quickstart guide**](https://redocly.com/docs/redoc/quickstart/) and [**How to use the HTML element**](https://redocly.com/docs/redoc/deployment/html/).\n\n## Redoc CLI\nFor more information on Redoc's command-line interface, refer to\n[**Using the Redoc CLI**](https://redocly.com/docs/redoc/deployment/cli/).\n\n\n## Configuration\n\n### Security Definition location\nYou can inject the Security Definitions widget into any place in your definition `description`.\nFor more information, refer to [Security definitions injection](docs/security-definitions-injection.md).\n\n### OpenAPI specification extensions\nRedoc uses the following [specification extensions](https://redocly.com/docs/api-reference-docs/spec-extensions/):\n* [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo\n* [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for handling out common things like Pagination, Rate-Limits, etc\n* [`x-codeSamples`](docs/redoc-vendor-extensions.md#x-codeSamples) - specify operation code samples\n* [`x-examples`](docs/redoc-vendor-extensions.md#x-examples) - specify JSON example for requests\n* [`x-nullable`](docs/redoc-vendor-extensions.md#x-nullable) - mark schema param as a nullable\n* [`x-displayName`](docs/redoc-vendor-extensions.md#x-displayname) - specify human-friendly names for the menu categories\n* [`x-tagGroups`](docs/redoc-vendor-extensions.md#x-tagGroups) - group tags by categories in the side menu\n* [`x-servers`](docs/redoc-vendor-extensions.md#x-servers) - ability to specify different servers for API (backported from OpenAPI 3.0)\n* [`x-ignoredHeaderParameters`](docs/redoc-vendor-extensions.md#x-ignoredHeaderParameters) - ability to specify header parameter names to ignore\n* [`x-additionalPropertiesName`](docs/redoc-vendor-extensions.md#x-additionalPropertiesName) - ability to supply a descriptive name for the additional property keys\n* [`x-summary`](docs/redoc-vendor-extensions.md#x-summary) - For Response object, use as the response button text, with description rendered under the button\n* [`x-extendedDiscriminator`](docs/redoc-vendor-extensions.md#x-extendedDiscriminator) - In Schemas, uses this to solve name-clash issues with the standard discriminator\n* [`x-explicitMappingOnly`](docs/redoc-vendor-extensions.md#x-explicitMappingOnly) - In Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object\n\n### `<redoc>` options object\nYou can use all of the following options with the standalone version of the <redoc> tag by kebab-casing them. For example, `scrollYOffset` becomes `scroll-y-offset`, and `expandResponses` becomes `expand-responses`.\n\n* `disableSearch` - disable search indexing and search box.\n* `minCharacterLengthToInitSearch` - set minimal characters length to init search, default `3`, minimal `1`.\n* `expandDefaultServerVariables` - enable expanding default server variables, default `false`.\n* `expandResponses` - specify which responses to expand by default by response codes. Values should be passed as comma-separated list without spaces e.g. `expandResponses=\"200,201\"`. Special value `\"all\"` expands all responses by default. Be careful: this option can slow-down documentation rendering time.\n* `generatedPayloadSamplesMaxDepth` - set the maximum render depth for JSON payload samples (responses and request body). The default value is `10`.\n* `maxDisplayedEnumValues` - display only specified number of enum values. hide rest values under spoiler.\n* `hideDownloadButton` - do not show \"Download\" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE**, it just hides the button.\n* `downloadFileName` - set a custom file name for the downloaded API definition file.\n* `downloadDefinitionUrl` - If the 'Download' button is visible in the API reference documentation (hideDownloadButton=false), the URL configured here will open when that button is selected. Provide it as an absolute URL with the full URI scheme.\n* `hideHostname` - if set, the protocol and hostname is not shown in the operation definition.\n* `hideLoading` - do not show loading animation. Useful for small docs.\n* `hideFab` - do not show FAB in mobile view. Useful for implementing a custom floating action button.\n* `hideSchemaPattern` - if set, the pattern is not shown in the schema.\n* `hideSingleRequestSampleTab` - do not show the request sample tab for requests with only one sample.\n* `showObjectSchemaExamples` - show object schema example in the properties, default `false`.\n* `expandSingleSchemaField` - automatically expand single field in a schema\n* `schemaExpansionLevel` - specifies whether to automatically expand schemas. Special value `\"all\"` expands all levels. The default value is `0`.\n* `jsonSampleExpandLevel` - set the default expand level for JSON payload samples (responses and request body). Special value `\"all\"` expands all levels. The default value is `2`.\n* `hideSchemaTitles` - do not display schema `title` next to to the type\n* `simpleOneOfTypeLabel` - show only unique oneOf types in the label without titles\n* `sortEnumValuesAlphabetically` - set to true, sorts all enum values in all schemas alphabetically\n* `sortOperationsAlphabetically` - set to true, sorts operations in the navigation sidebar and in the middle panel alphabetically\n* `sortTagsAlphabetically` - set to true, sorts tags in the navigation sidebar and in the middle panel alphabetically\n* `lazyRendering` - _Not implemented yet_ ~~if set, enables lazy rendering mode in ReDoc. This mode is useful for APIs with big number of operations (e.g. > 50). In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing progress bar on the top. Check out the [demo](\\\\redocly.github.io/redoc) for the example.~~\n* `menuToggle` - if true clicking second time on expanded menu item will collapse it, default `true`.\n* `nativeScrollbars` - use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs).\n* `onlyRequiredInSamples` - shows only required fields in request samples.\n* `pathInMiddlePanel` - show path link and HTTP verb in the middle panel instead of the right one.\n* `requiredPropsFirst` - show required properties first ordered in the same order as in `required` array.\n* `scrollYOffset` - If set, specifies a vertical scroll-offset. This is often useful when there are fixed positioned elements at the top of the page, such as navbars, headers etc;\n`scrollYOffset` can be specified in various ways:\n  * **number**: A fixed number of pixels to be used as offset.\n  * **selector**: selector of the element to be used for specifying the offset. The distance from the top of the page to the element's bottom will be used as offset.\n  * **function**: A getter function. Must return a number representing the offset (in pixels).\n* `showExtensions` - show vendor extensions (\"x-\" fields). Extensions used by Redoc are ignored. Can be boolean or an array of `string` with names of extensions to display.\n* `sortPropsAlphabetically` - sort properties alphabetically.\n* `payloadSampleIdx` - if set, payload sample will be inserted at this index or last. Indexes start from 0.\n* `theme` - Redoc theme. For details check [theme docs](#redoc-theme-object).\n* `untrustedSpec` - if set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS. **Disabled by default** for performance reasons. **Enable this option if you work with untrusted user data!**\n* `nonce` - if set, the provided value will be injected in every injected HTML element in the `nonce` attribute. Useful when using CSP, see https://webpack.js.org/guides/csp/.\n* `sideNavStyle` - can be specified in various ways:\n  * **summary-only**: displays a summary in the sidebar navigation item. (**default**)\n  * **path-only**: displays a path in the sidebar navigation item.\n  * **id-only**: displays the operation id with a fallback to the path in the sidebar navigation item.\n* `showWebhookVerb` - when set to `true`, shows the HTTP request method for webhooks in operations and in the sidebar.\n\n### `<redoc>` theme object\n* `spacing`\n  * `unit`: 5 # main spacing unit used in autocomputed theme values later\n  * `sectionHorizontal`: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8\n  * `sectionVertical`: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8\n* `breakpoints` # breakpoints for switching three/two and mobile view layouts\n  * `small`: '50rem'\n  * `medium`: '85rem'\n  * `large`: '105rem'\n* `colors`\n  * `tonalOffset`: 0.3 # default tonal offset used in computations\n* `typography`\n  * `fontSize`: '14px'\n  * `lineHeight`: '1.5em'\n  * `fontWeightRegular`: '400'\n  * `fontWeightBold`: '600'\n  * `fontWeightLight`: '300'\n  * `fontFamily`: 'Roboto, sans-serif'\n  * `smoothing`: 'antialiased'\n  * `optimizeSpeed`: true\n  * `headings`\n    * `fontFamily`: 'Montserrat, sans-serif'\n    * `fontWeight`: '400'\n    * `lineHeight`: '1.6em'\n  * `code` # inline code styling\n    * `fontSize`: '13px'\n    * `fontFamily`: 'Courier, monospace'\n    * `lineHeight`: # COMPUTED: typography.lineHeight\n    * `fontWeight`: # COMPUTED: typography.fontWeightRegular\n    * `color`: '#e53935'\n    * `backgroundColor`: 'rgba(38, 50, 56, 0.05)'\n    * `wrap`: false # whether to break word for inline blocks (otherwise they can overflow)\n  * `links`\n    * `color`: # COMPUTED: colors.primary.main\n    * `visited`: # COMPUTED: typography.links.color\n    * `hover`: # COMPUTED: lighten(0.2 typography.links.color)\n    * `textDecoration`: 'auto'\n    * `hoverTextDecoration`: 'auto'\n* `sidebar`\n  * `width`: '260px'\n  * `backgroundColor`: '#fafafa'\n  * `textColor`: '#333333'\n  * `activeTextColor`: # COMPUTED: theme.sidebar.textColor (if set by user) or theme.colors.primary.main\n  * `groupItems` # Group headings\n    * `activeBackgroundColor`: # COMPUTED: theme.sidebar.backgroundColor\n    * `activeTextColor`: # COMPUTED: theme.sidebar.activeTextColor\n    * `textTransform`: 'uppercase'\n  * `level1Items` # Level 1 items like tags or section 1st level items\n    * `activeBackgroundColor`: # COMPUTED: theme.sidebar.backgroundColor\n    * `activeTextColor`: # COMPUTED: theme.sidebar.activeTextColor\n    * `textTransform`: 'none'\n  * `arrow` # sidebar arrow\n    * `size`: '1.5em'\n    * `color`: # COMPUTED: theme.sidebar.textColor\n* `logo`\n  * `maxHeight`: # COMPUTED: sidebar.width\n  * `maxWidth`: # COMPUTED: sidebar.width\n  * `gutter`: '2px' # logo image padding\n* `rightPanel`\n  * `backgroundColor`: '#263238'\n  * `width`: '40%'\n  * `textColor`: '#ffffff'\n  * `servers`\n    * `overlay`\n      * `backgroundColor`: '#fafafa'\n      * `textColor`: '#263238'\n    * `url`\n      * `backgroundColor`: '#fff'\n* `fab`\n  * `backgroundColor`: '#263238'\n  * `color`: '#ffffff'\n\n-----------\n## Development\nsee [CONTRIBUTING.md](.github/CONTRIBUTING.md)\n","readmeFilename":"README.md"}