Comparing version 2.0.0-rc.56 to 2.0.0-rc.57
/*! | ||
* ReDoc - OpenAPI/Swagger-generated API Reference Documentation | ||
* ------------------------------------------------------------- | ||
* Version: "2.0.0-rc.56" | ||
* Version: "2.0.0-rc.57" | ||
* Repo: https://github.com/Redocly/redoc | ||
@@ -6,0 +6,0 @@ */ |
/*! | ||
* ReDoc - OpenAPI/Swagger-generated API Reference Documentation | ||
* ------------------------------------------------------------- | ||
* Version: "2.0.0-rc.56" | ||
* Version: "2.0.0-rc.57" | ||
* Repo: https://github.com/Redocly/redoc | ||
@@ -6,0 +6,0 @@ */ |
/*! | ||
* ReDoc - OpenAPI/Swagger-generated API Reference Documentation | ||
* ------------------------------------------------------------- | ||
* Version: "2.0.0-rc.56" | ||
* Version: "2.0.0-rc.57" | ||
* Repo: https://github.com/Redocly/redoc | ||
*/ |
@@ -16,3 +16,3 @@ /* | ||
* ------------------------------------------------------------- | ||
* Version: "2.0.0-rc.56" | ||
* Version: "2.0.0-rc.57" | ||
* Repo: https://github.com/Redocly/redoc | ||
@@ -19,0 +19,0 @@ */ |
{ | ||
"name": "redoc", | ||
"version": "2.0.0-rc.56", | ||
"version": "2.0.0-rc.57", | ||
"description": "ReDoc", | ||
@@ -82,2 +82,3 @@ "repository": { | ||
"@types/lunr": "^2.3.3", | ||
"@types/node": "^15.6.1", | ||
"@types/mark.js": "^8.11.5", | ||
@@ -150,5 +151,4 @@ "@types/marked": "^1.1.0", | ||
"@babel/runtime": "^7.14.0", | ||
"@redocly/openapi-core": "^1.0.0-beta.50", | ||
"@redocly/openapi-core": "^1.0.0-beta.54", | ||
"@redocly/react-dropdown-aria": "^2.0.11", | ||
"@types/node": "^15.6.1", | ||
"classnames": "^2.3.1", | ||
@@ -155,0 +155,0 @@ "decko": "^1.2.0", |
274
README.md
<div align="center"> | ||
<img alt="ReDoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/master/docs/images/redoc-logo.png" width="400px" /> | ||
<img alt="Redoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/master//docs/images/redoc.png" width="400px" /> | ||
**OpenAPI/Swagger-generated API Reference Documentation** | ||
# Generate interactive API documentation from OpenAPI definitions | ||
@@ -9,48 +9,104 @@ [![Build Status](https://travis-ci.com/Redocly/redoc.svg?branch=master)](https://travis-ci.com/Redocly/redoc) [![Coverage Status](https://coveralls.io/repos/Redocly/redoc/badge.svg?branch=master&service=github)](https://coveralls.io/github/Redocly/redoc?branch=master) [![dependencies Status](https://david-dm.org/Redocly/redoc/status.svg)](https://david-dm.org/Redocly/redoc) [![devDependencies Status](https://david-dm.org/Redocly/redoc/dev-status.svg)](https://david-dm.org/Redocly/redoc#info=devDependencies) [![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/master/LICENSE) | ||
[![bundle size](http://img.badgesize.io/https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js?compression=gzip&max=300000)](https://cdn.jsdelivr.net/npm/redoc/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/) | ||
</div> | ||
**This is the README for the `2.x` version of Redoc (React-based).** | ||
**The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch** | ||
</div> | ||
## About Redoc | ||
**This is README for `2.0` version of ReDoc (React based). README for `1.x` version is on the branch [v1.x](https://github.com/Redocly/redoc/tree/v1.x)** | ||
Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions. | ||
By default Redoc offers a three-panel, responsive layout: | ||
![ReDoc demo](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png) | ||
- The left panel contains a search bar and navigation menu. | ||
- The central panel contains the documentation. | ||
- The right panel contains request and response examples. | ||
## [Live demo](http://redocly.github.io/redoc/) | ||
![Redoc demo](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png) | ||
[<img alt="Deploy to Github" src="http://i.imgur.com/YZmaqk3.png" height="60px">](https://github.com/Rebilly/generator-openapi-repo#generator-openapi-repo--) [<img alt="ReDoc as a service" src="http://i.imgur.com/edqdCv6.png" height="60px">](https://redoc.ly) [<img alt="Customization services" src="http://i.imgur.com/c4sUF7M.png" height="60px">](https://redoc.ly/#services) | ||
## Live demo | ||
If you want to see how Redoc will render your OpenAPI definition, | ||
you can try it out online at https://redocly.github.io/redoc/. | ||
A version of the Swagger Petstore API is displayed by default. | ||
To test it with your own OpenAPI definition, | ||
enter the URL for your definition and select **TRY IT**. | ||
## Redoc vs. Reference vs. Portals | ||
Redoc is Redocly's community-edition product. Looking for something more? | ||
Checkout the following feature comparison of Redocly's premium products versus Redoc: | ||
| Features | Redoc | Reference | Portals | | ||
|------------------------------|:---------:|:---------:|:-----------:| | ||
| **Specs** | | | | | ||
| Swagger 2.0 | √ | √ | √ | | ||
| OpenAPI 3.0 | √ | √ | √ | | ||
| OpenAPI 3.1 | √ (basic) | √ | √ | | ||
| | | | | | ||
| **Theming** | | | | | ||
| Fonts/colors | √ | √ | √ | | ||
| Extra theme options | | √ | √ | | ||
| | | | | | ||
| **Performance** | | | | | ||
| Pagination | | √ | √ | | ||
| Search (enhanced) | | √ | √ | | ||
| Search (server-side) | | | √ | | ||
| | | | | | ||
| **Multiple APIs** | | | | | ||
| Multiple versions | | √ | √ | | ||
| Multiple APIs | | | √ | | ||
| API catalog | | | √ | | ||
| | | | | | ||
| **Additional features** | | | | | ||
| Try-it console | | √ | √ | | ||
| Automated code samples | | √ | √ | | ||
| Deep links | | √ | √ | | ||
| More SEO control | | | √ | | ||
| Contextual docs | | | √ | | ||
| Landing pages | | | √ | | ||
| React hooks for more control | | | √ | | ||
| Personalization | | | √ | | ||
| Analytics integrations | | | √ | | ||
| Feedback | | | Coming Soon | | ||
Refer to the Redocly's documentation for more information on these products: | ||
- [Portals](https://redoc.ly/docs/developer-portal/introduction/) | ||
- [Reference](https://redoc.ly/docs/api-reference-docs/getting-started/) | ||
- [Redoc](https://redoc.ly/docs/redoc/quickstart/intro/) | ||
## Features | ||
- Extremely easy deployment | ||
- [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) with ability to bundle your docs into **zero-dependency** HTML file | ||
- Server Side Rendering ready | ||
- The widest OpenAPI v2.0 features support (yes, it supports even `discriminator`) <br> | ||
![](docs/images/discriminator-demo.gif) | ||
- OpenAPI 3.0 support | ||
- Basic OpenAPI 3.1 support | ||
- Responsive three-panel design with menu/scrolling synchronization | ||
- [Multiple deployment options](https://redoc.ly/docs/redoc/quickstart/intro/) | ||
- [Server-side rendering (SSR) ready](https://redoc.ly/docs/redoc/quickstart/cli/#redoc-cli-commands) | ||
- Ability to integrate your API introduction into the side menu | ||
- [Simple integration with `create-react-app`](https://redoc.ly/docs/redoc/quickstart/react/) | ||
[Example repo](https://github.com/APIs-guru/create-react-app-redoc) | ||
- [Command-line interface to bundle your docs into a **zero-dependency** HTML file](https://redoc.ly/docs/redoc/quickstart/cli/) | ||
- Neat **interactive** documentation for nested objects <br> | ||
![](docs/images/nested-demo.gif) | ||
![](docs/images/nested-demo.gif) | ||
## Customization options | ||
[<img alt="Customization services" src="http://i.imgur.com/c4sUF7M.png" height="60px">](https://redoc.ly/#services) | ||
- High-level grouping in side-menu with the [`x-tagGroups`](https://redoc.ly/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension | ||
- Branding/customizations using the [`theme` option](https://redoc.ly/docs/api-reference-docs/configuration/theming/) | ||
## Support | ||
- OpenAPI v3.0 support | ||
- Basic OpenAPI v3.1 support | ||
- Broad OpenAPI v2.0 feature support (yes, it supports even `discriminator`) <br> | ||
![](docs/images/discriminator-demo.gif) | ||
- Code samples support (via vendor extension) <br> | ||
![](docs/images/code-samples-demo.gif) | ||
- Responsive three-panel design with menu/scrolling synchronization | ||
- Integrate API Introduction into side menu - ReDoc takes advantage of markdown headings from OpenAPI description field. It pulls them into side menu and also supports deep linking. | ||
- High-level grouping in side-menu via [`x-tagGroups`](docs/redoc-vendor-extensions.md#x-tagGroups) vendor extension | ||
- Simple integration with `create-react-app` ([sample](https://github.com/APIs-guru/create-react-app-redoc)) | ||
- Branding/customizations via [`theme` option](#redoc-options-object) | ||
![](docs/images/code-samples-demo.gif) | ||
## Roadmap | ||
- [x] ~~[OpenAPI v3.0 support](https://github.com/Redocly/redoc/issues/312)~~ | ||
- [x] ~~performance optimizations~~ | ||
- [x] ~~better navigation (menu improvements + search)~~ | ||
- [x] ~~React rewrite~~ | ||
- [x] ~~docs pre-rendering (performance and SEO)~~ | ||
- [ ] ability to simple branding/styling | ||
## Releases | ||
**Important:** all the 2.x releases are deployed to npm and can be used via jsdeliver: | ||
- particular release, e.g. `v2.0.0-alpha.15`: https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js | ||
**Important:** all the 2.x releases are deployed to npm and can be used with jsdeliver: | ||
- particular release, for example, `v2.0.0-alpha.15`: https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js | ||
- `next` release: https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js | ||
Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**: | ||
- particular release, e.g. `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js | ||
- particular release, for example `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js | ||
- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js | ||
@@ -60,3 +116,3 @@ - `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. | ||
## Version Guidance | ||
| ReDoc Release | OpenAPI Specification | | ||
| Redoc Release | OpenAPI Specification | | ||
|:--------------|:----------------------| | ||
@@ -69,3 +125,3 @@ | 2.0.0-alpha.54| 3.1, 3.0.x, 2.0 | | ||
## Some Real-life usages | ||
## Showcase | ||
- [Rebilly](https://api-reference.rebilly.com/) | ||
@@ -77,9 +133,19 @@ - [Docker Engine](https://docs.docker.com/engine/api/v1.25/) | ||
- [APIs.guru](https://apis.guru/api-doc/) | ||
- [FastAPI](https://github.com/tiangolo/fastapi) | ||
- [BoxKnight](https://www.docs.boxknight.com/) | ||
## Lint OpenAPI definitions | ||
Redocly's OpenAPI CLI is an open source command-line tool that you can use to lint | ||
your OpenAPI definition. Linting helps you to catch errors and inconsistencies in your | ||
OpenAPI definition before publishing. | ||
Refer to [Lint configuration](https://redoc.ly/docs/cli/guides/lint/) in the OpenAPI documentation for more information. | ||
## Deployment | ||
### TL;DR | ||
### TL;DR final code example | ||
To render your OpenAPI definition using Redoc, use the following HTML code sample and | ||
replace the `spec-url` attribute with the url or local file address to your definition. | ||
```html | ||
@@ -89,3 +155,3 @@ <!DOCTYPE html> | ||
<head> | ||
<title>ReDoc</title> | ||
<title>Redoc</title> | ||
<!-- needed for adaptive design --> | ||
@@ -97,3 +163,3 @@ <meta charset="utf-8"/> | ||
<!-- | ||
ReDoc doesn't change outer page styles | ||
Redoc doesn't change outer page styles | ||
--> | ||
@@ -109,113 +175,27 @@ <style> | ||
<redoc spec-url='http://petstore.swagger.io/v2/swagger.json'></redoc> | ||
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script> | ||
<script src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js"> </script> | ||
</body> | ||
</html> | ||
``` | ||
That's all folks! | ||
**IMPORTANT NOTE:** if you work with untrusted user spec, use `untrusted-spec` [option](#redoc-options-object) to prevent XSS security risks. | ||
### 1. Install ReDoc (skip this step for CDN) | ||
Install using [npm](https://docs.npmjs.com/getting-started/what-is-npm): | ||
npm i redoc | ||
or using [yarn](https://yarnpkg.com): | ||
yarn add redoc | ||
### 2. Reference redoc script in HTML | ||
For **CDN**: | ||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"> </script> | ||
``` | ||
For npm: | ||
```html | ||
<script src="node_modules/redoc/bundles/redoc.standalone.js"> </script> | ||
``` | ||
For step-by-step instructions for how to get started using Redoc | ||
to render your OpenAPI definition, refer to the | ||
[**Redoc quickstart guide**](https://redoc.ly/docs/redoc/quickstart/intro/). | ||
### 3. Add `<redoc>` element to your page | ||
```html | ||
<redoc spec-url="url/to/your/spec"></redoc> | ||
``` | ||
See [**IE11 Support Notes**](docs/usage-with-ie11.md) for information on | ||
IE support for Redoc. | ||
### 4. Enjoy :smile: | ||
## Redoc CLI | ||
For more information on Redoc's commmand-line interface, refer to | ||
[**Using the Redoc CLI**](https://redoc.ly/docs/redoc/quickstart/cli/). | ||
## Usage as a React component | ||
Install peer dependencies required by ReDoc if you don't have them installed already: | ||
npm i react react-dom mobx styled-components core-js | ||
Import `RedocStandalone` component from 'redoc' module: | ||
```js | ||
import { RedocStandalone } from 'redoc'; | ||
``` | ||
and use it somewhere in your component: | ||
```js | ||
<RedocStandalone specUrl="url/to/your/spec"/> | ||
``` | ||
or | ||
```js | ||
<RedocStandalone spec={/* spec as an object */}/> | ||
``` | ||
Also you can pass options: | ||
```js | ||
<RedocStandalone | ||
specUrl="https://api.redoc.ly/registry/rebilly/core-api/core/bundle/master/openapi.yaml" | ||
options={{ | ||
nativeScrollbars: true, | ||
theme: { colors: { primary: { main: '#dd5522' } } }, | ||
}} | ||
/> | ||
``` | ||
Here are detailed [options docs](#redoc-options-object). | ||
You can also specify `onLoaded` callback which will be called each time Redoc has been fully rendered or when error occurs (with an error as the first argument). *NOTE*: It may be called multiply times if you change component properties | ||
```js | ||
<RedocStandalone | ||
specUrl="https://api.redoc.ly/registry/rebilly/core-api/core/bundle/master/openapi.yaml" | ||
onLoaded={error => { | ||
if (!error) { | ||
console.log('Yay!'); | ||
} | ||
}} | ||
/> | ||
``` | ||
[**IE11 Support Notes**](docs/usage-with-ie11.md) | ||
## The Docker way | ||
ReDoc is available as pre-built Docker image in official [Docker Hub repository](https://hub.docker.com/r/redocly/redoc/). You may simply pull & run it: | ||
docker pull redocly/redoc | ||
docker run -p 8080:80 redocly/redoc | ||
Also you may rewrite some predefined environment variables defined in [Dockerfile](./config/docker/Dockerfile). By default ReDoc starts with demo Petstore spec located at `http://petstore.swagger.io/v2/swagger.json`, but you may change this URL using environment variable `SPEC_URL`: | ||
docker run -p 8080:80 -e SPEC_URL=https://api.example.com/openapi.json redocly/redoc | ||
## ReDoc CLI | ||
[See here](https://github.com/Redocly/redoc/blob/master/cli/README.md) | ||
## Configuration | ||
### Security Definition location | ||
You can inject Security Definitions widget into any place of your specification `description`. Check out details [here](docs/security-definitions-injection.md). | ||
You can inject the Security Definitions widget into any place in your definition `description`. | ||
For more information, refer to [Security definitions injection](docs/security-definitions-injection.md). | ||
### Swagger vendor extensions | ||
ReDoc makes use of the following [vendor extensions](https://swagger.io/specification/#specificationExtensions): | ||
### OpenAPI specification extensions | ||
Redoc uses the following [specification extensions](https://swagger.io/specification/#specificationExtensions): | ||
* [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo | ||
@@ -236,3 +216,3 @@ * [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for handling out common things like Pagination, Rate-Limits, etc | ||
### `<redoc>` options object | ||
You can use all of the following options with standalone version on <redoc> tag by kebab-casing them, e.g. `scrollYOffset` becomes `scroll-y-offset` and `expandResponses` becomes `expand-responses`. | ||
You 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`. | ||
@@ -242,2 +222,3 @@ * `disableSearch` - disable search indexing and search box. | ||
* `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. | ||
* `generatedPayloadSamplesMaxDepth` - set the maximum render depth for JSON payload samples (responses and request body). The default value is `10`. | ||
* `maxDisplayedEnumValues` - display only specified number of enum values. hide rest values under spoiler. | ||
@@ -328,21 +309,4 @@ * `hideDownloadButton` - do not show "Download" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE**, it just hides the button. | ||
## Advanced usage of standalone version | ||
Instead of adding `spec-url` attribute to the `<redoc>` element you can initialize ReDoc via globally exposed `Redoc` object: | ||
```js | ||
Redoc.init(specOrSpecUrl, options, element, callback?) | ||
``` | ||
- `specOrSpecUrl` is either JSON object with specification or an URL to the spec in `JSON` or `YAML` format | ||
- `options` [options object](#redoc-options-object) | ||
- `element` DOM element to put ReDoc into | ||
- `callback` (optional) - callback to be called after Redoc has been fully rendered. It is also called on errors with error as the first argument | ||
```js | ||
Redoc.init('http://petstore.swagger.io/v2/swagger.json', { | ||
scrollYOffset: 50 | ||
}, document.getElementById('redoc-container')) | ||
``` | ||
----------- | ||
## Development | ||
see [CONTRIBUTING.md](.github/CONTRIBUTING.md) |
@@ -16,2 +16,3 @@ import * as React from 'react'; | ||
results: SearchResult[]; | ||
noResults: boolean; | ||
term: string; | ||
@@ -18,0 +19,0 @@ activeItemIdx: number; |
@@ -13,2 +13,3 @@ export interface LabelsConfig { | ||
const: string; | ||
noResultsFound: string; | ||
download: string; | ||
@@ -15,0 +16,0 @@ downloadSpecification: string; |
@@ -14,2 +14,3 @@ import { OpenAPIMediaType } from '../../types'; | ||
onlyRequiredInSamples: boolean; | ||
generatedPayloadSamplesMaxDepth: number; | ||
/** | ||
@@ -16,0 +17,0 @@ * @param isRequestType needed to know if skipe RO/RW fields in objects |
@@ -49,2 +49,3 @@ import { IMenuItem } from '../MenuStore'; | ||
isWebhook: boolean; | ||
isEvent: boolean; | ||
constructor(parser: OpenAPIParser, operationSpec: ExtendedOpenAPIOperation, parent: GroupModel | undefined, options: RedocNormalizedOptions, isCallback?: boolean); | ||
@@ -51,0 +52,0 @@ /** |
@@ -5,2 +5,8 @@ import { OpenAPIRequestBody, Referenced } from '../../types'; | ||
import { MediaContentModel } from './MediaContent'; | ||
declare type RequestBodyProps = { | ||
parser: OpenAPIParser; | ||
infoOrRef: Referenced<OpenAPIRequestBody>; | ||
options: RedocNormalizedOptions; | ||
isEvent: boolean; | ||
}; | ||
export declare class RequestBodyModel { | ||
@@ -10,3 +16,4 @@ description: string; | ||
content?: MediaContentModel; | ||
constructor(parser: OpenAPIParser, infoOrRef: Referenced<OpenAPIRequestBody>, options: RedocNormalizedOptions); | ||
constructor(props: RequestBodyProps); | ||
} | ||
export {}; |
@@ -6,2 +6,10 @@ import { OpenAPIResponse, Referenced } from '../../types'; | ||
import { MediaContentModel } from './MediaContent'; | ||
declare type ResponseProps = { | ||
parser: OpenAPIParser; | ||
code: string; | ||
defaultAsError: boolean; | ||
infoOrRef: Referenced<OpenAPIResponse>; | ||
options: RedocNormalizedOptions; | ||
isEvent: boolean; | ||
}; | ||
export declare class ResponseModel { | ||
@@ -15,4 +23,5 @@ expanded: boolean; | ||
headers: FieldModel[]; | ||
constructor(parser: OpenAPIParser, code: string, defaultAsError: boolean, infoOrRef: Referenced<OpenAPIResponse>, options: RedocNormalizedOptions); | ||
constructor(props: ResponseProps); | ||
toggle(): void; | ||
} | ||
export {}; |
@@ -40,2 +40,4 @@ import { OpenAPIExternalDocumentation, OpenAPISchema, Referenced } from '../../types'; | ||
contentMediaType?: string; | ||
minItems?: number; | ||
maxItems?: number; | ||
/** | ||
@@ -42,0 +44,0 @@ * @param isChild if schema discriminator Child |
@@ -37,4 +37,4 @@ import { OpenAPIRef, OpenAPISchema, OpenAPISpec, Referenced } from '../types'; | ||
deref<T extends object>(obj: OpenAPIRef | T, forceCircular?: boolean, mergeAsAllOf?: boolean): T; | ||
shallowDeref<T extends unknown>(obj: OpenAPIRef | T): T; | ||
mergeRefs(ref: any, resolved: any, mergeAsAllOf: boolean): any; | ||
shalowDeref<T extends object>(obj: OpenAPIRef | T): T; | ||
/** | ||
@@ -41,0 +41,0 @@ * Merge allOf constraints. |
@@ -36,2 +36,3 @@ import { ResolvedThemeInterface, ThemeInterface } from '../theme'; | ||
hideSchemaPattern?: boolean; | ||
generatedPayloadSamplesMaxDepth?: number; | ||
} | ||
@@ -46,2 +47,3 @@ export declare function argValueToBoolean(val?: string | boolean, defaultValue?: boolean): boolean; | ||
private static normalizeJsonSampleExpandLevel; | ||
private static normalizeGeneratedPayloadSamplesMaxDepth; | ||
theme: ResolvedThemeInterface; | ||
@@ -78,3 +80,4 @@ scrollYOffset: () => number; | ||
hideSchemaPattern: boolean; | ||
generatedPayloadSamplesMaxDepth: number; | ||
constructor(raw: RedocRawOptions, defaults?: RedocRawOptions); | ||
} |
@@ -17,2 +17,3 @@ import 'prismjs/components/prism-bash.js'; | ||
import 'prismjs/components/prism-python.js'; | ||
import 'prismjs/components/prism-q.js'; | ||
import 'prismjs/components/prism-ruby.js'; | ||
@@ -19,0 +20,0 @@ import 'prismjs/components/prism-scala.js'; |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
6420377
29
7944
80
158
303
- Removed@types/node@^15.6.1
- Removed@types/node@15.14.9(transitive)