redoc 2.0.0-rc.52 → 2.0.0-rc.56

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 (39) hide show
  1. package/README.md +5 -3
  2. package/bundles/9bcbfb5fe4bb244b68d4.worker.js.LICENSE.txt +68 -0
  3. package/bundles/9bcbfb5fe4bb244b68d4.worker.js.map +1 -0
  4. package/bundles/cf2d816ec177c47e23d0.worker.js.LICENSE.txt +68 -0
  5. package/bundles/cf2d816ec177c47e23d0.worker.js.map +1 -0
  6. package/bundles/redoc.lib.js +2 -14904
  7. package/bundles/redoc.lib.js.LICENSE.txt +6 -0
  8. package/bundles/redoc.lib.js.map +1 -1
  9. package/bundles/redoc.standalone.js +2 -106
  10. package/bundles/redoc.standalone.js.LICENSE.txt +106 -0
  11. package/bundles/redoc.standalone.js.map +1 -1
  12. package/package.json +92 -79
  13. package/typings/common-elements/fields.d.ts +0 -1
  14. package/typings/common-elements/linkify.d.ts +3 -7
  15. package/typings/components/Fields/EnumValues.d.ts +1 -1
  16. package/typings/components/RedocStandalone.d.ts +2 -11
  17. package/typings/components/RequestSamples/CodeSample.d.ts +22 -0
  18. package/typings/components/StoreBuilder.d.ts +6 -18
  19. package/typings/index.d.ts +3 -2
  20. package/typings/services/Labels.d.ts +7 -1
  21. package/typings/services/MenuBuilder.d.ts +1 -1
  22. package/typings/services/OpenAPIParser.d.ts +3 -2
  23. package/typings/services/RedocNormalizedOptions.d.ts +1 -0
  24. package/typings/services/models/ApiInfo.d.ts +1 -0
  25. package/typings/services/models/Field.d.ts +1 -0
  26. package/typings/services/models/Operation.d.ts +1 -1
  27. package/typings/services/models/Schema.d.ts +5 -1
  28. package/typings/services/models/Webhook.d.ts +1 -0
  29. package/typings/styled-components.d.ts +3 -3
  30. package/typings/types/index.d.ts +1 -2
  31. package/typings/types/index.ts +3 -0
  32. package/typings/types/open-api.d.ts +232 -218
  33. package/typings/types/open-api.ts +282 -0
  34. package/typings/utils/highlight.d.ts +1 -0
  35. package/typings/utils/media-css.d.ts +6 -0
  36. package/typings/utils/openapi.d.ts +4 -3
  37. package/CHANGELOG.md +0 -1832
  38. package/bundles/6d3017e92bb2b2c03e6b.worker.js.map +0 -1
  39. package/bundles/dbef64fdf885888b28c4.worker.js.map +0 -1
package/README.md CHANGED
@@ -26,6 +26,7 @@
26
26
  - The widest OpenAPI v2.0 features support (yes, it supports even `discriminator`) <br>
27
27
  ![](docs/images/discriminator-demo.gif)
28
28
  - OpenAPI 3.0 support
29
+ - Basic OpenAPI 3.1 support
29
30
  - Neat **interactive** documentation for nested objects <br>
30
31
  ![](docs/images/nested-demo.gif)
31
32
  - Code samples support (via vendor extension) <br>
@@ -43,7 +44,6 @@
43
44
  - [x] ~~React rewrite~~
44
45
  - [x] ~~docs pre-rendering (performance and SEO)~~
45
46
  - [ ] ability to simple branding/styling
46
- - [ ] built-in API Console
47
47
 
48
48
  ## Releases
49
49
  **Important:** all the 2.x releases are deployed to npm and can be used via jsdeliver:
@@ -58,6 +58,7 @@ Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(d
58
58
  ## Version Guidance
59
59
  | ReDoc Release | OpenAPI Specification |
60
60
  |:--------------|:----------------------|
61
+ | 2.0.0-alpha.54| 3.1, 3.0.x, 2.0 |
61
62
  | 2.0.0-alpha.x | 3.0, 2.0 |
62
63
  | 1.19.x | 2.0 |
63
64
  | 1.18.x | 2.0 |
@@ -71,6 +72,7 @@ Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(d
71
72
  - [Commbox](https://www.commbox.io/api/)
72
73
  - [APIs.guru](https://apis.guru/api-doc/)
73
74
  - [FastAPI](https://github.com/tiangolo/fastapi)
75
+ - [BoxKnight](https://www.docs.boxknight.com/)
74
76
 
75
77
  ## Deployment
76
78
 
@@ -162,7 +164,7 @@ Also you can pass options:
162
164
 
163
165
  ```js
164
166
  <RedocStandalone
165
- specUrl="http://rebilly.github.io/RebillyAPI/openapi.json"
167
+ specUrl="https://api.redoc.ly/registry/rebilly/core-api/core/bundle/master/openapi.yaml"
166
168
  options={{
167
169
  nativeScrollbars: true,
168
170
  theme: { colors: { primary: { main: '#dd5522' } } },
@@ -176,7 +178,7 @@ You can also specify `onLoaded` callback which will be called each time Redoc ha
176
178
 
177
179
  ```js
178
180
  <RedocStandalone
179
- specUrl="http://rebilly.github.io/RebillyAPI/openapi.json"
181
+ specUrl="https://api.redoc.ly/registry/rebilly/core-api/core/bundle/master/openapi.yaml"
180
182
  onLoaded={error => {
181
183
  if (!error) {
182
184
  console.log('Yay!');
package/bundles/9bcbfb5fe4bb244b68d4.worker.js.LICENSE.txt ADDED
@@ -0,0 +1,68 @@
1
+ /*!
2
+ * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
3
+ * -------------------------------------------------------------
4
+ * Version: "2.0.0-rc.56"
5
+ * Repo: https://github.com/Redocly/redoc
6
+ */
7
+
8
+ /*!
9
+ * lunr.Builder
10
+ * Copyright (C) 2020 Oliver Nightingale
11
+ */
12
+
13
+ /*!
14
+ * lunr.Index
15
+ * Copyright (C) 2020 Oliver Nightingale
16
+ */
17
+
18
+ /*!
19
+ * lunr.Pipeline
20
+ * Copyright (C) 2020 Oliver Nightingale
21
+ */
22
+
23
+ /*!
24
+ * lunr.Set
25
+ * Copyright (C) 2020 Oliver Nightingale
26
+ */
27
+
28
+ /*!
29
+ * lunr.TokenSet
30
+ * Copyright (C) 2020 Oliver Nightingale
31
+ */
32
+
33
+ /*!
34
+ * lunr.Vector
35
+ * Copyright (C) 2020 Oliver Nightingale
36
+ */
37
+
38
+ /*!
39
+ * lunr.stemmer
40
+ * Copyright (C) 2020 Oliver Nightingale
41
+ * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
42
+ */
43
+
44
+ /*!
45
+ * lunr.stopWordFilter
46
+ * Copyright (C) 2020 Oliver Nightingale
47
+ */
48
+
49
+ /*!
50
+ * lunr.tokenizer
51
+ * Copyright (C) 2020 Oliver Nightingale
52
+ */
53
+
54
+ /*!
55
+ * lunr.trimmer
56
+ * Copyright (C) 2020 Oliver Nightingale
57
+ */
58
+
59
+ /*!
60
+ * lunr.utils
61
+ * Copyright (C) 2020 Oliver Nightingale
62
+ */
63
+
64
+ /**
65
+ * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
66
+ * Copyright (C) 2020 Oliver Nightingale
67
+ * @license MIT
68
+ */