redoc 2.0.0-rc.58 → 2.0.0-rc.61

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.
Files changed (42) hide show
  1. package/CHANGELOG.md +35 -1
  2. package/README.md +9 -6
  3. package/bundles/{09308330094436e5b844.worker.js.LICENSE.txt → 8dbd28457ff989b4568a.worker.js.LICENSE.txt} +1 -1
  4. package/bundles/{09308330094436e5b844.worker.js.map → 8dbd28457ff989b4568a.worker.js.map} +1 -1
  5. package/bundles/redoc.browser.lib.js +1738 -1
  6. package/bundles/redoc.browser.lib.js.LICENSE.txt +3 -1
  7. package/bundles/redoc.browser.lib.js.map +1 -1
  8. package/bundles/redoc.lib.js +1738 -1
  9. package/bundles/redoc.lib.js.LICENSE.txt +3 -1
  10. package/bundles/redoc.lib.js.map +1 -1
  11. package/bundles/redoc.standalone.js +1730 -1
  12. package/bundles/redoc.standalone.js.LICENSE.txt +18 -1
  13. package/bundles/redoc.standalone.js.map +1 -1
  14. package/package.json +17 -31
  15. package/typings/components/Fields/ArrayItemDetails.d.ts +5 -0
  16. package/typings/components/Fields/EnumValues.d.ts +1 -1
  17. package/typings/components/Fields/Examples.d.ts +5 -0
  18. package/typings/components/Fields/FieldDetail.d.ts +1 -3
  19. package/typings/components/Fields/FieldDetails.d.ts +1 -10
  20. package/typings/components/Fields/Pattern.d.ts +5 -0
  21. package/typings/components/Responses/Response.d.ts +3 -5
  22. package/typings/components/Responses/ResponseTitle.d.ts +1 -3
  23. package/typings/components/Responses/styled.elements.d.ts +2 -2
  24. package/typings/components/Schema/ObjectSchema.d.ts +2 -6
  25. package/typings/components/Schema/Schema.d.ts +1 -0
  26. package/typings/services/MarkdownRenderer.d.ts +3 -2
  27. package/typings/services/MenuBuilder.d.ts +4 -0
  28. package/typings/services/MenuStore.d.ts +1 -0
  29. package/typings/services/RedocNormalizedOptions.d.ts +15 -0
  30. package/typings/services/models/Field.d.ts +2 -0
  31. package/typings/services/models/Group.model.d.ts +1 -0
  32. package/typings/services/models/Operation.d.ts +1 -0
  33. package/typings/services/models/RequestBody.d.ts +1 -1
  34. package/typings/services/models/Response.d.ts +2 -1
  35. package/typings/types/open-api.d.ts +13 -6
  36. package/typings/types/open-api.ts +7 -4
  37. package/typings/utils/dom.d.ts +1 -0
  38. package/typings/utils/index.d.ts +1 -0
  39. package/typings/utils/openapi.d.ts +5 -1
  40. package/typings/utils/sort.d.ts +6 -0
  41. package/bundles/574a25b96816f2c682b8.worker.js.LICENSE.txt +0 -68
  42. package/bundles/574a25b96816f2c682b8.worker.js.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,37 @@
1
+ # [2.0.0-rc.60](https://github.com/Redocly/redoc/compare/v2.0.0-rc.59...v2.0.0-rc.60) (2022-01-25)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * add schema expansion level ([#1868](https://github.com/Redocly/redoc/issues/1868)) ([250d53a](https://github.com/Redocly/redoc/commit/250d53a59fb4bf881875ba466c5a7f3b55d80007))
7
+ * attachHeadingsDescriptions match headings incorrectly ([#1845](https://github.com/Redocly/redoc/issues/1845)) ([ea8573d](https://github.com/Redocly/redoc/commit/ea8573dbd78439be50aa2b38f1c83658c16783e3))
8
+ * definition name util ([#1865](https://github.com/Redocly/redoc/issues/1865)) ([95a7347](https://github.com/Redocly/redoc/commit/95a734793158d4749e98ee4a7e90e70713a04ced))
9
+ * No maxLength label is displayed for arrays of items [#1701](https://github.com/Redocly/redoc/issues/1701) ([#1765](https://github.com/Redocly/redoc/issues/1765)) ([6c7685e](https://github.com/Redocly/redoc/commit/6c7685e5fa04314328a445d7077600692c49489c))
10
+ * Response objects couldn't open ([#1867](https://github.com/Redocly/redoc/issues/1867)) ([18f943d](https://github.com/Redocly/redoc/commit/18f943d2b5668f1552d212dee1c3a2ed59054095))
11
+ * writeOnly params displaying in webhook ([#1866](https://github.com/Redocly/redoc/issues/1866)) ([5694913](https://github.com/Redocly/redoc/commit/5694913e71f0e8c3a5d9393f1b4ae92534127841))
12
+
13
+
14
+ ### Features
15
+
16
+ * **#1251:** Add file selector to demo application ([#1859](https://github.com/Redocly/redoc/issues/1859)) ([b74dcde](https://github.com/Redocly/redoc/commit/b74dcde42b45ebe5ae617f1ec3cfea2ea1aff922)), closes [#1251](https://github.com/Redocly/redoc/issues/1251) [#1251](https://github.com/Redocly/redoc/issues/1251) [#1251](https://github.com/Redocly/redoc/issues/1251)
17
+ * redoc-cli add host option ([#1598](https://github.com/Redocly/redoc/issues/1598)) ([fb104e6](https://github.com/Redocly/redoc/commit/fb104e696618b0b81439da134887830a0f2439ea))
18
+ * support examples in object schema ([#1832](https://github.com/Redocly/redoc/issues/1832)) ([c986f0e](https://github.com/Redocly/redoc/commit/c986f0ef1a38bc1e61cae70830d84de03b684b89))
19
+
20
+
21
+
22
+ # [2.0.0-rc.59](https://github.com/Redocly/redoc/compare/v2.0.0-rc.58...v2.0.0-rc.59) (2021-12-09)
23
+
24
+
25
+ ### Bug Fixes
26
+
27
+ * fix scroll in example dropdown ([#1803](https://github.com/Redocly/redoc/issues/1803)) ([bc2d9a7](https://github.com/Redocly/redoc/commit/bc2d9a7d9cd530274483fecd136db290a5b46ff7))
28
+ * 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))
29
+
30
+ ### Features
31
+
32
+ * add option sideNavStyle ([#1805](https://github.com/Redocly/redoc/pull/1805)) ([2e4663b](https://github.com/Redocly/redoc/commit/2e4663b3b7022f25d3dc808afbcb3b3ad9483c41))
33
+
34
+
1
35
  # [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
36
 
3
37
 
@@ -43,7 +77,7 @@
43
77
  * improve openapi 3.1 ([#1700](https://github.com/Redocly/redoc/issues/1700)) ([cd2d6f7](https://github.com/Redocly/redoc/commit/cd2d6f76e87c8385786a9c8e51c0d11c79d9707c))
44
78
  - show contentEncoding on fields
45
79
  - crash with OpenAPI 3.1 type as array of strings in requestBody
46
- - nullable label not shown
80
+ - nullable label not shown
47
81
  * nullable object's fields were missing ([#1721](https://github.com/Redocly/redoc/issues/1721)) ([ddf297b](https://github.com/Redocly/redoc/commit/ddf297b11269ef515bd62771912a5609721d5e39))
48
82
 
49
83
 
package/README.md CHANGED
@@ -8,14 +8,14 @@
8
8
  [![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/)
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`
@@ -1,7 +1,7 @@
1
1
  /*!
2
2
  * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
3
3
  * -------------------------------------------------------------
4
- * Version: "2.0.0-rc.58"
4
+ * Version: "2.0.0-rc.61"
5
5
  * Repo: https://github.com/Redocly/redoc
6
6
  */
7
7