redoc 2.1.3 → 2.1.4

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 (14) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +7 -8
  3. package/bundles/756674defce81e90acea.worker.js.LICENSE.txt +1 -1
  4. package/bundles/redoc.browser.lib.js +151 -145
  5. package/bundles/redoc.browser.lib.js.LICENSE.txt +1 -1
  6. package/bundles/redoc.browser.lib.js.map +1 -1
  7. package/bundles/redoc.lib.js +149 -143
  8. package/bundles/redoc.lib.js.LICENSE.txt +1 -1
  9. package/bundles/redoc.lib.js.map +1 -1
  10. package/bundles/redoc.standalone.js +261 -255
  11. package/bundles/redoc.standalone.js.LICENSE.txt +5 -5
  12. package/bundles/redoc.standalone.js.map +1 -1
  13. package/package.json +21 -21
  14. package/typings/services/OpenAPIParser.d.ts +4 -4
package/CHANGELOG.md CHANGED
@@ -1,3 +1,14 @@
1
+ ## [2.1.4](https://github.com/Redocly/redoc/compare/v2.1.3...v2.1.4) (2024-04-25)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * add deprecated css to clickable property name ([#2526](https://github.com/Redocly/redoc/issues/2526)) ([b0d03d0](https://github.com/Redocly/redoc/commit/b0d03d02069c1508447ddebc2f8a3fffa9b03ce5))
7
+ * use h2/h3 for headings instead of h1/h2 for better seo ([#2514](https://github.com/Redocly/redoc/issues/2514)) ([2b72dc0](https://github.com/Redocly/redoc/commit/2b72dc0e90f759a8ee2e47691c844e7f05928a24))
8
+ * security vulnerability ([#2445](https://github.com/Redocly/redoc/pull/2445)) ([1f11f5](https://github.com/Redocly/redoc/commit/1f11f597c4f10ddd601db247f5034052b6ca689f))
9
+
10
+
11
+
1
12
  ## [2.1.3](https://github.com/Redocly/redoc/compare/v2.1.2...v2.1.3) (2023-10-24)
2
13
 
3
14
 
package/README.md CHANGED
@@ -1,11 +1,11 @@
1
1
  <div align="center">
2
2
  <img alt="Redoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/main//docs/images/redoc.png" width="400px" />
3
3
 
4
- # Generate interactive API documentation from OpenAPI definitions
4
+ # Generate beautiful API documentation from OpenAPI
5
5
 
6
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)
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) [![jsDelivr status](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc)
9
9
  </div>
10
10
 
11
11
 
@@ -34,13 +34,11 @@ enter the URL for your definition and select **TRY IT**.
34
34
 
35
35
  - Responsive three-panel design with menu/scrolling synchronization
36
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
39
37
  - Ability to integrate your API introduction into the side menu
40
38
  - High-level grouping in side menu with the [`x-tagGroups`](https://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension
41
39
  - [Simple integration with `create-react-app`](https://redocly.com/docs/redoc/quickstart/react/)
42
40
  - Code samples support (with vendor extension) <br>
43
- ![](docs/images/code-samples-demo.gif)
41
+ ![code samples in action](docs/images/code-samples-demo.gif)
44
42
 
45
43
  ## Usage
46
44
 
@@ -50,7 +48,7 @@ Redoc is provided as a CLI tool (also distributed as a Docker image), HTML tag,
50
48
 
51
49
  If you have Node installed, quickly generate documentation using `npx`:
52
50
 
53
- ```
51
+ ```bash
54
52
  npx @redocly/cli build-docs openapi.yaml
55
53
  ```
56
54
 
@@ -73,9 +71,9 @@ Add your own `spec-url` to the `<redoc>` tag; this attribute can also be a local
73
71
 
74
72
  ### More usage options
75
73
 
76
- Check out the [deployment documentation](./deploment/index/md) for more options, and detailed documentation for each.
74
+ Check out the [deployment documentation](./docs/deployment/intro.md) for more options, and detailed documentation for each.
77
75
 
78
- ## Redoc vs. Reference
76
+ ## Redoc vs. Redocly API Reference
79
77
 
80
78
  Redoc is Redocly's community-edition product. Looking for something more?
81
79
  We also offer [hosted API reference documentation](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/)
@@ -104,6 +102,7 @@ A sample of the organizations using Redocly tools in the wild:
104
102
  - [Commbox](https://www.commbox.io/api/)
105
103
  - [APIs.guru](https://apis.guru/api-doc/)
106
104
  - [BoxKnight](https://www.docs.boxknight.com/)
105
+ - [Quaderno API](https://developers.quaderno.io/api)
107
106
 
108
107
  _Pull requests to add your own API page to the list are welcome_
109
108
 
package/bundles/756674defce81e90acea.worker.js.LICENSE.txt CHANGED
@@ -1,7 +1,7 @@
1
1
  /*!
2
2
  * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
3
3
  * -------------------------------------------------------------
4
- * Version: "2.1.3"
4
+ * Version: "2.1.4"
5
5
  * Repo: https://github.com/Redocly/redoc
6
6
  */
7
7