{"id":14971579,"url":"https://github.com/redocly/redoc","last_synced_at":"2025-09-09T20:14:06.728Z","repository":{"id":37444785,"uuid":"45250726","full_name":"Redocly/redoc","owner":"Redocly","description":"📘  OpenAPI/Swagger-generated API Reference Documentation","archived":false,"fork":false,"pushed_at":"2025-09-05T05:31:52.000Z","size":58942,"stargazers_count":24904,"open_issues_count":390,"forks_count":2353,"subscribers_count":300,"default_branch":"main","last_synced_at":"2025-09-05T06:04:12.799Z","etag":null,"topics":["api-documentation","documentation-generator","documentation-tool","hacktoberfest","openapi","openapi-specification","openapi3","openapi31","reactjs","redoc","swagger"],"latest_commit_sha":null,"homepage":"https://redocly.github.io/redoc/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Redocly.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"docs/security-definitions-injection.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-10-30T12:53:02.000Z","updated_at":"2025-09-05T05:31:56.000Z","dependencies_parsed_at":"2023-10-23T13:26:49.269Z","dependency_job_id":"a2890045-c25d-4034-a12c-2f5df38804e1","html_url":"https://github.com/Redocly/redoc","commit_stats":{"total_commits":2552,"total_committers":229,"mean_commits":11.14410480349345,"dds":0.2405956112852664,"last_synced_commit":"639fd2c32c18ae5ff5937d76eb5ab70fc2bc2f86"},"previous_names":["rebilly/redoc"],"tags_count":228,"template":false,"template_full_name":null,"purl":"pkg:github/Redocly/redoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Redocly","download_url":"https://codeload.github.com/Redocly/redoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc/sbom","scorecard":{"id":119111,"data":{"date":"2025-08-11","repo":{"name":"github.com/Redocly/redoc","commit":"4d15a1fd5b32c644a4beb99a09b7af22f10e432c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":6,"reason":"5 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":9,"reason":"Found 21/22 approved changesets -- score normalized to 9","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/docs-tests.yaml:1","Warn: no topLevel permission defined: .github/workflows/e2e-tests.yml:1","Warn: no topLevel permission defined: .github/workflows/main.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/unit-tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/main.yml:6"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs-tests.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/docs-tests.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs-tests.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/docs-tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs-tests.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/docs-tests.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs-tests.yaml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/docs-tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs-tests.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/docs-tests.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs-tests.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/docs-tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e-tests.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/e2e-tests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:102: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:104: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:121: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:123: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-tests.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/Redocly/redoc/unit-tests.yml/main?enable=pin","Warn: containerImage not pinned by hash: config/docker/Dockerfile:8: pin your Docker image by updating node:18-alpine to node:18-alpine@sha256:8d6421d663b4c28fd3ebc498332f249011d118945588d0a35cb9bc4b8ca09d9e","Warn: containerImage not pinned by hash: config/docker/Dockerfile:26: pin your Docker image by updating nginx:alpine to nginx:alpine@sha256:d67ea0d64d518b1bb04acde3b00f722ac3e9764b3209a9b0a98924ba35e4b779","Info:   0 out of  22 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  11 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned","Info:   7 out of   7 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":7,"reason":"SAST tool is not run on all commits -- score normalized to 7","details":["Warn: 23 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T02:07:45.130Z","repository_id":37444785,"created_at":"2025-08-16T02:07:45.130Z","updated_at":"2025-08-16T02:07:45.130Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274357326,"owners_count":25270673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","documentation-generator","documentation-tool","hacktoberfest","openapi","openapi-specification","openapi3","openapi31","reactjs","redoc","swagger"],"created_at":"2024-09-24T13:45:27.930Z","updated_at":"2025-09-09T20:14:06.649Z","avatar_url":"https://github.com/Redocly.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"Redoc logo\" src=\"https://raw.githubusercontent.com/Redocly/redoc/main//docs/images/redoc.png\" width=\"400px\" /\u003e\n\n# Generate beautiful API documentation from OpenAPI\n\n  [![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\u0026max=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) [![jsDelivr status](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc)\n\u003c/div\u003e\n\n\n## About Redoc\n\nRedoc is an open source tool for generating documentation from OpenAPI (formerly 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 renders 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 features\n\n- Responsive three-panel design with menu/scrolling synchronization\n- Support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0\n- Ability to integrate your API introduction into the side menu\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- [Simple integration with `create-react-app`](https://redocly.com/docs/redoc/quickstart/react/)\n- Code samples support (with vendor extension) \u003cbr\u003e\n  ![code samples in action](docs/images/code-samples-demo.gif)\n\n## Usage\n\nRedoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component.\n\n### Generate documentation from the CLI\n\nIf you have Node installed, quickly generate documentation using `npx`:\n\n```bash\nnpx @redocly/cli build-docs openapi.yaml\n```\n\nThe tool outputs by default to a file named `redoc-static.html` that you can open in your browser.\n\n\u003e [Redocly CLI](https://github.com/Redocly/redocly-cli/) does more than docs; check it out and add linting, bundling, and more to your API workflow.\n\n### Add an HTML element to the page\n\nCreate an HTML page, or edit an existing one, and add the following within the body tags:\n\n```html\n    \u003credoc spec-url=\"http://petstore.swagger.io/v2/swagger.json\"\u003e\u003c/redoc\u003e\n    \u003cscript src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"\u003e \u003c/script\u003e\n```\n\nOpen the HTML file in your browser, and your API documentation is shown on the page.\n\nAdd your own `spec-url` to the `\u003credoc\u003e` tag; this attribute can also be a local file. The JavaScript library can also be installed locally using `npm` and served from your own server, see the [HTML deployment documentation](https://redocly.com/docs/redoc/deployment/html/) for more details.\n\n### More usage options\n\nCheck out the [deployment documentation](./docs/deployment/intro.md) for more options, and detailed documentation for each.\n\n## Redoc vs. Redocly API Reference\n\nRedoc is Redocly's community-edition product. Looking for something more?\nWe also offer [hosted API reference documentation](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/)\nwith additional features including:\n\n* Try-it console\n* Automated code samples\n* Pagination\n* Extra theme options\n\n### Documentation and resources\n\n- [Reference docs](https://redocly.com/docs/api-reference-docs/getting-started/) - we take care of the hosting\n- [Redoc](https://redocly.com/docs/redoc/) - detailed documentation for this open source project (also in the `docs/` folder)\n- [Command-line interface to bundle your docs into a web-ready HTML file](https://redocly.com/docs/cli/commands/build-docs/)\n- API linting, bundling, and much more with open source [Redocly CLI](https://redocly.com/docs/cli)\n\n## Showcase\n\nA sample of the organizations using Redocly tools in the wild:\n\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- [Quaderno API](https://developers.quaderno.io/api)\n\n_Pull requests to add your own API page to the list are welcome_\n\n## Configuration\n\nRedoc is highly configurable, see the [configuration documentation](docs/config.md) for details.\n\n### OpenAPI specification extensions\nRedoc uses the following [specification extensions](https://redocly.com/docs/api-reference-docs/spec-extensions/):\n\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 tags that refer to non-navigation properties like Pagination, Rate-Limits, etc\n* [`x-codeSamples`](docs/redoc-vendor-extensions.md#x-codeSamples) - specify operation code samples\n* [`x-badges`](docs/redoc-vendor-extensions.md#x-badges) - specify operation badges\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-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-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## Releases\n\n**The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch.**\n\nAll 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 - points to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.\n\n\n## Development\nsee [CONTRIBUTING.md](.github/CONTRIBUTING.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredocly%2Fredoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredocly%2Fredoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredocly%2Fredoc/lists"}