redoc 2.1.1 → 2.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,25 @@
1
+ ## [2.1.3](https://github.com/Redocly/redoc/compare/v2.1.2...v2.1.3) (2023-10-24)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * default value as object in request body ([#2437](https://github.com/Redocly/redoc/issues/2437)) ([b36a6e2](https://github.com/Redocly/redoc/commit/b36a6e27bb3e03d39ee74c3e71f18a504539d91b))
7
+ * display string pattern in array items ([#2438](https://github.com/Redocly/redoc/issues/2438)) ([8ddeb6d](https://github.com/Redocly/redoc/commit/8ddeb6dfda686ec8a6948eb2d96efb99bf422429))
8
+ * hideRequestPayloadSample ([#2436](https://github.com/Redocly/redoc/issues/2436)) ([bf96061](https://github.com/Redocly/redoc/commit/bf960612a47bfe10ff205b9d78f3040515a5467d))
9
+ * more cases for react18 and cli integration ([#2416](https://github.com/Redocly/redoc/issues/2416)) ([26674e7](https://github.com/Redocly/redoc/commit/26674e70c66b686d0f0baa569b186292c41e5726))
10
+
11
+
12
+
13
+ ## [2.1.2](https://github.com/Redocly/redoc/compare/v2.1.1...v2.1.2) (2023-09-11)
14
+
15
+
16
+ ### Bug Fixes
17
+
18
+ * react18 cli integration ([#2404](https://github.com/Redocly/redoc/issues/2404)) ([76edc15](https://github.com/Redocly/redoc/commit/76edc159399150778b384be87ee958a93e5c491c))
19
+ * style RefreshToken URL as <code> in the authorization section ([1d61001](https://github.com/Redocly/redoc/commit/1d6100111a0f3b609dadbd706354ce6125947df2))
20
+
21
+
22
+
1
23
  ## [2.1.1](https://github.com/Redocly/redoc/compare/v2.1.0...v2.1.1) (2023-08-17)
2
24
 
3
25
 
package/README.md CHANGED
@@ -3,17 +3,15 @@
3
3
 
4
4
  # Generate interactive API documentation from OpenAPI definitions
5
5
 
6
- [![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)
6
+ [![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)
7
7
 
8
- [![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/)
8
+ [![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)
9
9
  </div>
10
10
 
11
- **This is the README for the `2.x` version of Redoc (React-based).**
12
- **The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch.**
13
11
 
14
12
  ## About Redoc
15
13
 
16
- Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.
14
+ Redoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions.
17
15
 
18
16
  By default Redoc offers a three-panel, responsive layout:
19
17
 
@@ -32,161 +30,92 @@ A version of the Swagger Petstore API is displayed by default.
32
30
  To test it with your own OpenAPI definition,
33
31
  enter the URL for your definition and select **TRY IT**.
34
32
 
35
- ## Redoc vs. Reference vs. Portals
33
+ ## Redoc features
36
34
 
37
- Redoc is Redocly's community-edition product. Looking for something more?
38
- Checkout the following feature comparison of Redocly's premium products versus Redoc:
39
-
40
- | Features | Redoc | Reference | Portals |
41
- |------------------------------|:---------:|:---------:|:-----------:|
42
- | **Specs** | | | |
43
- | Swagger 2.0 | √ | √ | √ |
44
- | OpenAPI 3.0 | √ | √ | √ |
45
- | OpenAPI 3.1 | √ (basic) | √ | √ |
46
- | | | | |
47
- | **Theming** | | | |
48
- | Fonts/colors | √ | √ | √ |
49
- | Extra theme options | | √ | √ |
50
- | | | | |
51
- | **Performance** | | | |
52
- | Pagination | | √ | √ |
53
- | Search (enhanced) | | √ | √ |
54
- | Search (server-side) | | | √ |
55
- | | | | |
56
- | **Multiple APIs** | | | |
57
- | Multiple versions | | √ | √ |
58
- | Multiple APIs | | | √ |
59
- | API catalog | | | √ |
60
- | | | | |
61
- | **Additional features** | | | |
62
- | Try-it console | | √ | √ |
63
- | Automated code samples | | √ | √ |
64
- | Deep links | | √ | √ |
65
- | More SEO control | | | √ |
66
- | Contextual docs | | | √ |
67
- | Landing pages | | | √ |
68
- | React hooks for more control | | | √ |
69
- | Personalization | | | √ |
70
- | Analytics integrations | | | √ |
71
- | Feedback | | | Coming Soon |
72
-
73
- Refer to the Redocly's documentation for more information on these products:
74
-
75
- - [Portals](https://redocly.com/docs/developer-portal/introduction/)
76
- - [Reference](https://redocly.com/docs/api-reference-docs/getting-started/)
77
- - [Redoc](https://redocly.com/docs/redoc/quickstart/intro/)
78
-
79
- ## Features
80
35
  - Responsive three-panel design with menu/scrolling synchronization
81
- - [Multiple deployment options](https://redocly.com/docs/redoc/quickstart/intro/)
82
- - [Server-side rendering (SSR) ready](https://redocly.com/docs/redoc/quickstart/cli/#redoc-cli-commands)
36
+ - Support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0
37
+ - [Multiple deployment options](https://redocly.com/docs/redoc/)
38
+ - Interactive interface so your users can try the API immediately
83
39
  - Ability to integrate your API introduction into the side menu
40
+ - High-level grouping in side menu with the [`x-tagGroups`](https://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension
84
41
  - [Simple integration with `create-react-app`](https://redocly.com/docs/redoc/quickstart/react/)
85
-
86
- [Example repo](https://github.com/APIs-guru/create-react-app-redoc)
87
- - [Command-line interface to bundle your docs into a **zero-dependency** HTML file](https://redocly.com/docs/cli/commands/build-docs/)
88
- - Neat **interactive** documentation for nested objects <br>
89
- ![](docs/images/nested-demo.gif)
90
-
91
- ## Customization options
92
- [<img alt="Customization services" src="http://i.imgur.com/c4sUF7M.png" height="60px">](https://redocly.com/#services)
93
- - High-level grouping in side-menu with the [`x-tagGroups`](https://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension
94
- - Branding/customizations using the [`theme` option](https://redocly.com/docs/api-reference-docs/configuration/theming/)
95
-
96
- ## Support
97
- - OpenAPI v3.0 support
98
- - Basic OpenAPI v3.1 support
99
- - Broad OpenAPI v2.0 feature support (yes, it supports even `discriminator`) <br>
100
- ![](docs/images/discriminator-demo.gif)
101
- - Code samples support (via vendor extension) <br>
42
+ - Code samples support (with vendor extension) <br>
102
43
  ![](docs/images/code-samples-demo.gif)
103
44
 
104
- ## Releases
105
- **Important:** all the 2.x releases are deployed to npm and can be used with Redocly-cdn:
106
- - particular release, for example, `v2.0.0`: https://cdn.redoc.ly/redoc/v2.0.0/bundles/redoc.standalone.js
107
- - `latest` release: https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js
45
+ ## Usage
108
46
 
109
- Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**:
110
- - particular release, for example `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js
111
- - `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
112
- - `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.
47
+ Redoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component.
113
48
 
114
- ## Version Guidance
115
- | Redoc Release | OpenAPI Specification |
116
- |:--------------|:----------------------|
117
- | 2.0.0-alpha.54| 3.1, 3.0.x, 2.0 |
118
- | 2.0.0-alpha.x | 3.0, 2.0 |
119
- | 1.19.x | 2.0 |
120
- | 1.18.x | 2.0 |
121
- | 1.17.x | 2.0 |
49
+ ### Generate documentation from the CLI
122
50
 
123
- ## Showcase
124
- - [Rebilly](https://api-reference.rebilly.com/)
125
- - [Docker Engine](https://docs.docker.com/engine/api/v1.25/)
126
- - [Zuora](https://www.zuora.com/developer/api-reference/)
127
- - [Discourse](http://docs.discourse.org)
128
- - [Commbox](https://www.commbox.io/api/)
129
- - [APIs.guru](https://apis.guru/api-doc/)
130
- - [BoxKnight](https://www.docs.boxknight.com/)
131
-
132
- ## Lint OpenAPI definitions
51
+ If you have Node installed, quickly generate documentation using `npx`:
133
52
 
134
- Redocly CLI is an [open source command-line tool](https://github.com/Redocly/redocly-cli) that you can use to lint
135
- your OpenAPI definition. Linting helps you to catch errors and inconsistencies in your
136
- OpenAPI definition before publishing.
53
+ ```
54
+ npx @redocly/cli build-docs openapi.yaml
55
+ ```
137
56
 
138
- Learn more about [API standards and linting](https://redocly.com/docs/cli/api-standards/) in the main Redocly documentation.
57
+ The tool outputs by default to a file named `redoc-static.html` that you can open in your browser.
139
58
 
140
- ## Deployment
59
+ > [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.
141
60
 
142
- ### TL;DR final code example
61
+ ### Add an HTML element to the page
143
62
 
144
- To render your OpenAPI definition using Redoc, use the following HTML code sample and
145
- replace the `spec-url` attribute with the url or local file address to your definition.
63
+ Create an HTML page, or edit an existing one, and add the following within the body tags:
146
64
 
147
65
  ```html
148
- <!DOCTYPE html>
149
- <html>
150
- <head>
151
- <title>Redoc</title>
152
- <!-- needed for adaptive design -->
153
- <meta charset="utf-8"/>
154
- <meta name="viewport" content="width=device-width, initial-scale=1">
155
- <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
156
-
157
- <!--
158
- Redoc doesn't change outer page styles
159
- -->
160
- <style>
161
- body {
162
- margin: 0;
163
- padding: 0;
164
- }
165
- </style>
166
- </head>
167
- <body>
168
- <redoc spec-url='http://petstore.swagger.io/v2/swagger.json'></redoc>
66
+ <redoc spec-url="http://petstore.swagger.io/v2/swagger.json"></redoc>
169
67
  <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
170
- </body>
171
- </html>
172
-
173
68
  ```
174
69
 
175
- For step-by-step instructions for how to get started using Redoc
176
- to render your OpenAPI definition, refer to the
177
- [**Redoc quickstart guide**](https://redocly.com/docs/redoc/quickstart/) and [**How to use the HTML element**](https://redocly.com/docs/redoc/deployment/html/).
70
+ Open the HTML file in your browser, and your API documentation is shown on the page.
71
+
72
+ Add your own `spec-url` to the `<redoc>` 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.
73
+
74
+ ### More usage options
75
+
76
+ Check out the [deployment documentation](./deploment/index/md) for more options, and detailed documentation for each.
77
+
78
+ ## Redoc vs. Reference
79
+
80
+ Redoc is Redocly's community-edition product. Looking for something more?
81
+ We also offer [hosted API reference documentation](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/)
82
+ with additional features including:
83
+
84
+ * Try-it console
85
+ * Automated code samples
86
+ * Pagination
87
+ * Extra theme options
178
88
 
89
+ ### Documentation and resources
90
+
91
+ - [Reference docs](https://redocly.com/docs/api-reference-docs/getting-started/) - we take care of the hosting
92
+ - [Redoc](https://redocly.com/docs/redoc/) - detailed documentation for this open source project (also in the `docs/` folder)
93
+ - [Command-line interface to bundle your docs into a web-ready HTML file](https://redocly.com/docs/cli/commands/build-docs/)
94
+ - API linting, bundling, and much more with open source [Redocly CLI](https://redocly.com/docs/cli)
95
+
96
+ ## Showcase
97
+
98
+ A sample of the organizations using Redocly tools in the wild:
99
+
100
+ - [Rebilly](https://api-reference.rebilly.com/)
101
+ - [Docker Engine](https://docs.docker.com/engine/api/v1.25/)
102
+ - [Zuora](https://www.zuora.com/developer/api-reference/)
103
+ - [Discourse](http://docs.discourse.org)
104
+ - [Commbox](https://www.commbox.io/api/)
105
+ - [APIs.guru](https://apis.guru/api-doc/)
106
+ - [BoxKnight](https://www.docs.boxknight.com/)
107
+
108
+ _Pull requests to add your own API page to the list are welcome_
179
109
 
180
110
  ## Configuration
181
111
 
182
- ### Security Definition location
183
- You can inject the Security Definitions widget into any place in your definition `description`.
184
- For more information, refer to [Security definitions injection](docs/security-definitions-injection.md).
112
+ Redoc is highly configurable, see the [configuration documentation](docs/config.md) for details.
185
113
 
186
114
  ### OpenAPI specification extensions
187
115
  Redoc uses the following [specification extensions](https://redocly.com/docs/api-reference-docs/spec-extensions/):
116
+
188
117
  * [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo
189
- * [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for handling out common things like Pagination, Rate-Limits, etc
118
+ * [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for tags that refer to non-navigation properties like Pagination, Rate-Limits, etc
190
119
  * [`x-codeSamples`](docs/redoc-vendor-extensions.md#x-codeSamples) - specify operation code samples
191
120
  * [`x-examples`](docs/redoc-vendor-extensions.md#x-examples) - specify JSON example for requests
192
121
  * [`x-nullable`](docs/redoc-vendor-extensions.md#x-nullable) - mark schema param as a nullable
@@ -195,130 +124,23 @@ Redoc uses the following [specification extensions](https://redocly.com/docs/api
195
124
  * [`x-servers`](docs/redoc-vendor-extensions.md#x-servers) - ability to specify different servers for API (backported from OpenAPI 3.0)
196
125
  * [`x-ignoredHeaderParameters`](docs/redoc-vendor-extensions.md#x-ignoredHeaderParameters) - ability to specify header parameter names to ignore
197
126
  * [`x-additionalPropertiesName`](docs/redoc-vendor-extensions.md#x-additionalPropertiesName) - ability to supply a descriptive name for the additional property keys
198
- * [`x-summary`](docs/redoc-vendor-extensions.md#x-summary) - For Response object, use as the response button text, with description rendered under the button
199
- * [`x-extendedDiscriminator`](docs/redoc-vendor-extensions.md#x-extendedDiscriminator) - In Schemas, uses this to solve name-clash issues with the standard discriminator
200
- * [`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
201
-
202
- ### `<redoc>` options object
203
- 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`.
204
-
205
- * `disableSearch` - disable search indexing and search box.
206
- * `minCharacterLengthToInitSearch` - set minimal characters length to init search, default `3`, minimal `1`.
207
- * `expandDefaultServerVariables` - enable expanding default server variables, default `false`.
208
- * `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.
209
- * `generatedPayloadSamplesMaxDepth` - set the maximum render depth for JSON payload samples (responses and request body). The default value is `10`.
210
- * `maxDisplayedEnumValues` - display only specified number of enum values. hide rest values under spoiler.
211
- * `hideDownloadButton` - do not show "Download" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE**, it just hides the button.
212
- * `downloadFileName` - set a custom file name for the downloaded API definition file.
213
- * `downloadDefinitionUrl` - If the 'Download' button is visible in the API reference documentation (hideDownloadButton=false), the URL configured here opens when that button is selected. Provide it as an absolute URL with the full URI scheme.
214
- * `hideHostname` - if set, the protocol and hostname is not shown in the operation definition.
215
- * `hideLoading` - do not show loading animation. Useful for small docs.
216
- * `hideFab` - do not show FAB in mobile view. Useful for implementing a custom floating action button.
217
- * `hideSchemaPattern` - if set, the pattern is not shown in the schema.
218
- * `hideSingleRequestSampleTab` - do not show the request sample tab for requests with only one sample.
219
- * `showObjectSchemaExamples` - show object schema example in the properties, default `false`.
220
- * `expandSingleSchemaField` - automatically expand single field in a schema
221
- * `schemaExpansionLevel` - specifies whether to automatically expand schemas. Special value `"all"` expands all levels. The default value is `0`.
222
- * `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`.
223
- * `hideSchemaTitles` - do not display schema `title` next to to the type
224
- * `simpleOneOfTypeLabel` - show only unique oneOf types in the label without titles
225
- * `sortEnumValuesAlphabetically` - set to true, sorts all enum values in all schemas alphabetically
226
- * `sortOperationsAlphabetically` - set to true, sorts operations in the navigation sidebar and in the middle panel alphabetically
227
- * `sortTagsAlphabetically` - set to true, sorts tags in the navigation sidebar and in the middle panel alphabetically
228
- * `menuToggle` - if true, clicking second time on expanded menu item collapses it, default `true`.
229
- * `nativeScrollbars` - use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs).
230
- * `onlyRequiredInSamples` - shows only required fields in request samples.
231
- * `pathInMiddlePanel` - show path link and HTTP verb in the middle panel instead of the right one.
232
- * `requiredPropsFirst` - show required properties first ordered in the same order as in `required` array.
233
- * `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;
234
- `scrollYOffset` can be specified in various ways:
235
- * **number**: A fixed number of pixels to be used as offset.
236
- * **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 is used as offset.
237
- * **function**: A getter function. Must return a number representing the offset (in pixels).
238
- * `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.
239
- * `sortPropsAlphabetically` - sort properties alphabetically.
240
- * `payloadSampleIdx` - if set, payload sample is inserted at this index or last. Indexes start from 0.
241
- * `theme` - Redoc theme. For details check [theme docs](#redoc-theme-object).
242
- * `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!**
243
- * `nonce` - if set, the provided value is injected in every injected HTML element in the `nonce` attribute. Useful when using CSP, see https://webpack.js.org/guides/csp/.
244
- * `sideNavStyle` - can be specified in various ways:
245
- * **summary-only**: displays a summary in the sidebar navigation item. (**default**)
246
- * **path-only**: displays a path in the sidebar navigation item.
247
- * **id-only**: displays the operation id with a fallback to the path in the sidebar navigation item.
248
- * `showWebhookVerb` - when set to `true`, shows the HTTP request method for webhooks in operations and in the sidebar.
249
-
250
- ### `<redoc>` theme object
251
- * `spacing`
252
- * `unit`: 5 # main spacing unit used in autocomputed theme values later
253
- * `sectionHorizontal`: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
254
- * `sectionVertical`: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
255
- * `breakpoints` # breakpoints for switching three/two and mobile view layouts
256
- * `small`: '50rem'
257
- * `medium`: '85rem'
258
- * `large`: '105rem'
259
- * `colors`
260
- * `tonalOffset`: 0.3 # default tonal offset used in computations
261
- * `typography`
262
- * `fontSize`: '14px'
263
- * `lineHeight`: '1.5em'
264
- * `fontWeightRegular`: '400'
265
- * `fontWeightBold`: '600'
266
- * `fontWeightLight`: '300'
267
- * `fontFamily`: 'Roboto, sans-serif'
268
- * `smoothing`: 'antialiased'
269
- * `optimizeSpeed`: true
270
- * `headings`
271
- * `fontFamily`: 'Montserrat, sans-serif'
272
- * `fontWeight`: '400'
273
- * `lineHeight`: '1.6em'
274
- * `code` # inline code styling
275
- * `fontSize`: '13px'
276
- * `fontFamily`: 'Courier, monospace'
277
- * `lineHeight`: # COMPUTED: typography.lineHeight
278
- * `fontWeight`: # COMPUTED: typography.fontWeightRegular
279
- * `color`: '#e53935'
280
- * `backgroundColor`: 'rgba(38, 50, 56, 0.05)'
281
- * `wrap`: false # whether to break word for inline blocks (otherwise they can overflow)
282
- * `links`
283
- * `color`: # COMPUTED: colors.primary.main
284
- * `visited`: # COMPUTED: typography.links.color
285
- * `hover`: # COMPUTED: lighten(0.2 typography.links.color)
286
- * `textDecoration`: 'auto'
287
- * `hoverTextDecoration`: 'auto'
288
- * `sidebar`
289
- * `width`: '260px'
290
- * `backgroundColor`: '#fafafa'
291
- * `textColor`: '#333333'
292
- * `activeTextColor`: # COMPUTED: theme.sidebar.textColor (if set by user) or theme.colors.primary.main
293
- * `groupItems` # Group headings
294
- * `activeBackgroundColor`: # COMPUTED: theme.sidebar.backgroundColor
295
- * `activeTextColor`: # COMPUTED: theme.sidebar.activeTextColor
296
- * `textTransform`: 'uppercase'
297
- * `level1Items` # Level 1 items like tags or section 1st level items
298
- * `activeBackgroundColor`: # COMPUTED: theme.sidebar.backgroundColor
299
- * `activeTextColor`: # COMPUTED: theme.sidebar.activeTextColor
300
- * `textTransform`: 'none'
301
- * `arrow` # sidebar arrow
302
- * `size`: '1.5em'
303
- * `color`: # COMPUTED: theme.sidebar.textColor
304
- * `logo`
305
- * `maxHeight`: # COMPUTED: sidebar.width
306
- * `maxWidth`: # COMPUTED: sidebar.width
307
- * `gutter`: '2px' # logo image padding
308
- * `rightPanel`
309
- * `backgroundColor`: '#263238'
310
- * `width`: '40%'
311
- * `textColor`: '#ffffff'
312
- * `servers`
313
- * `overlay`
314
- * `backgroundColor`: '#fafafa'
315
- * `textColor`: '#263238'
316
- * `url`
317
- * `backgroundColor`: '#fff'
318
- * `fab`
319
- * `backgroundColor`: '#263238'
320
- * `color`: '#ffffff'
321
-
322
- -----------
127
+ * [`x-summary`](docs/redoc-vendor-extensions.md#x-summary) - for Response object, use as the response button text, with description rendered under the button
128
+ * [`x-extendedDiscriminator`](docs/redoc-vendor-extensions.md#x-extendedDiscriminator) - in Schemas, uses this to solve name-clash issues with the standard discriminator
129
+ * [`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
130
+
131
+ ## Releases
132
+
133
+ **The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch.**
134
+
135
+ All the 2.x releases are deployed to npm and can be used with Redocly-cdn:
136
+ - particular release, for example, `v2.0.0`: https://cdn.redoc.ly/redoc/v2.0.0/bundles/redoc.standalone.js
137
+ - `latest` release: https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js
138
+
139
+ Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**:
140
+ - particular release, for example `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js
141
+ - `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
142
+ - `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.
143
+
144
+
323
145
  ## Development
324
146
  see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
@@ -1,7 +1,7 @@
1
1
  /*!
2
2
  * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
3
3
  * -------------------------------------------------------------
4
- * Version: "2.1.1"
4
+ * Version: "2.1.3"
5
5
  * Repo: https://github.com/Redocly/redoc
6
6
  */
7
7