redoc 2.0.0-rc.58 → 2.0.0-rc.59
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 +14 -1
- package/README.md +9 -6
- package/bundles/09308330094436e5b844.worker.js.LICENSE.txt +1 -1
- package/bundles/574a25b96816f2c682b8.worker.js.LICENSE.txt +1 -1
- package/bundles/redoc.browser.lib.js +1 -1
- package/bundles/redoc.browser.lib.js.LICENSE.txt +1 -1
- package/bundles/redoc.browser.lib.js.map +1 -1
- package/bundles/redoc.lib.js +1 -1
- package/bundles/redoc.lib.js.LICENSE.txt +1 -1
- package/bundles/redoc.lib.js.map +1 -1
- package/bundles/redoc.standalone.js +1 -1
- package/bundles/redoc.standalone.js.LICENSE.txt +1 -1
- package/bundles/redoc.standalone.js.map +1 -1
- package/package.json +8 -8
- package/typings/services/MenuStore.d.ts +1 -0
- package/typings/services/RedocNormalizedOptions.d.ts +7 -0
- package/typings/services/models/Group.model.d.ts +1 -0
- package/typings/services/models/Operation.d.ts +1 -0
- package/typings/types/open-api.d.ts +12 -5
- package/typings/types/open-api.ts +6 -3
- package/typings/utils/dom.d.ts +1 -0
- package/typings/utils/openapi.d.ts +4 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
# [2.0.0-rc.59](https://github.com/Redocly/redoc/compare/v2.0.0-rc.58...v2.0.0-rc.59) (2021-12-09)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* fix scroll in example dropdown ([#1803](https://github.com/Redocly/redoc/issues/1803)) ([bc2d9a7](https://github.com/Redocly/redoc/commit/bc2d9a7d9cd530274483fecd136db290a5b46ff7))
|
|
7
|
+
* x-examples for request body param does not display [#1743](https://github.com/Redocly/redoc/issues/1743) ([#1826](https://github.com/Redocly/redoc/issues/1826)) ([aaa3b32](https://github.com/Redocly/redoc/commit/aaa3b3280c8422d450e8849ae02135dde199d6d5))
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* add option sideNavStyle ([#1805](https://github.com/Redocly/redoc/pull/1805)) ([2e4663b](https://github.com/Redocly/redoc/commit/2e4663b3b7022f25d3dc808afbcb3b3ad9483c41))
|
|
12
|
+
|
|
13
|
+
|
|
1
14
|
# [2.0.0-rc.58](https://github.com/Redocly/redoc/compare/v2.0.0-rc.57...v2.0.0-rc.58) (2021-11-29)
|
|
2
15
|
|
|
3
16
|
|
|
@@ -43,7 +56,7 @@
|
|
|
43
56
|
* improve openapi 3.1 ([#1700](https://github.com/Redocly/redoc/issues/1700)) ([cd2d6f7](https://github.com/Redocly/redoc/commit/cd2d6f76e87c8385786a9c8e51c0d11c79d9707c))
|
|
44
57
|
- show contentEncoding on fields
|
|
45
58
|
- crash with OpenAPI 3.1 type as array of strings in requestBody
|
|
46
|
-
- nullable label not shown
|
|
59
|
+
- nullable label not shown
|
|
47
60
|
* nullable object's fields were missing ([#1721](https://github.com/Redocly/redoc/issues/1721)) ([ddf297b](https://github.com/Redocly/redoc/commit/ddf297b11269ef515bd62771912a5609721d5e39))
|
|
48
61
|
|
|
49
62
|
|
package/README.md
CHANGED
|
@@ -8,14 +8,14 @@
|
|
|
8
8
|
[](https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js) [](https://www.npmjs.com/package/redoc) [](https://www.jsdelivr.com/package/npm/redoc) [](https://hub.docker.com/r/redocly/redoc/)
|
|
9
9
|
</div>
|
|
10
10
|
|
|
11
|
-
**This is the README for the `2.x` version of Redoc (React-based).**
|
|
11
|
+
**This is the README for the `2.x` version of Redoc (React-based).**
|
|
12
12
|
**The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch**
|
|
13
13
|
|
|
14
14
|
## About Redoc
|
|
15
15
|
|
|
16
|
-
Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.
|
|
16
|
+
Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.
|
|
17
17
|
|
|
18
|
-
By default Redoc offers a three-panel, responsive layout:
|
|
18
|
+
By default Redoc offers a three-panel, responsive layout:
|
|
19
19
|
|
|
20
20
|
- The left panel contains a search bar and navigation menu.
|
|
21
21
|
- The central panel contains the documentation.
|
|
@@ -133,7 +133,7 @@ Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(d
|
|
|
133
133
|
|
|
134
134
|
Redocly's OpenAPI CLI is an open source command-line tool that you can use to lint
|
|
135
135
|
your OpenAPI definition. Linting helps you to catch errors and inconsistencies in your
|
|
136
|
-
OpenAPI definition before publishing.
|
|
136
|
+
OpenAPI definition before publishing.
|
|
137
137
|
|
|
138
138
|
Refer to [Lint configuration](https://redoc.ly/docs/cli/guides/lint/) in the OpenAPI documentation for more information.
|
|
139
139
|
|
|
@@ -173,10 +173,10 @@ replace the `spec-url` attribute with the url or local file address to your defi
|
|
|
173
173
|
```
|
|
174
174
|
|
|
175
175
|
For step-by-step instructions for how to get started using Redoc
|
|
176
|
-
to render your OpenAPI definition, refer to the
|
|
176
|
+
to render your OpenAPI definition, refer to the
|
|
177
177
|
[**Redoc quickstart guide**](https://redoc.ly/docs/redoc/quickstart/intro/).
|
|
178
178
|
|
|
179
|
-
See [**IE11 Support Notes**](docs/usage-with-ie11.md) for information on
|
|
179
|
+
See [**IE11 Support Notes**](docs/usage-with-ie11.md) for information on
|
|
180
180
|
IE support for Redoc.
|
|
181
181
|
|
|
182
182
|
## Redoc CLI
|
|
@@ -240,6 +240,9 @@ You can use all of the following options with the standalone version of the <red
|
|
|
240
240
|
* `payloadSampleIdx` - if set, payload sample will be inserted at this index or last. Indexes start from 0.
|
|
241
241
|
* `theme` - ReDoc theme. For details check [theme docs](#redoc-theme-object).
|
|
242
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
|
+
* `sideNavStyle` - can be specified in various ways:
|
|
244
|
+
* **summary-only**: displays a summary in the sidebar navigation item. (**default**)
|
|
245
|
+
* **path-only**: displays a path in the sidebar navigation item.
|
|
243
246
|
|
|
244
247
|
### `<redoc>` theme object
|
|
245
248
|
* `spacing`
|