redoc 3.0.0-rc.4 → 3.0.1
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/README.md +1 -10
- package/bundles/redoc.d.ts +3 -1
- package/bundles/redoc.js +1032 -1032
- package/bundles/redoc.standalone.d.ts +2 -1
- package/bundles/redoc.standalone.js +831 -831
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,13 +1,5 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
<a href="https://redocly.com/redoc-ce">
|
|
4
|
-
<picture>
|
|
5
|
-
<source media="(prefers-color-scheme: dark)" srcset="./images/redoc-3-announcement-dark.gif">
|
|
6
|
-
<source media="(prefers-color-scheme: light)" srcset="./images/redoc-3-announcement-light.gif">
|
|
7
|
-
<img alt="Redoc 3.0 — one renderer for OpenAPI 3.2, AsyncAPI, GraphQL, and MCP" src="./images/redoc-3-announcement-light.gif">
|
|
8
|
-
</picture>
|
|
9
|
-
</a>
|
|
10
|
-
|
|
11
3
|
**[Learn what's new in Redoc 3.x →](https://redocly.com/redoc-ce)**
|
|
12
4
|
|
|
13
5
|
|
|
@@ -53,7 +45,6 @@ enter the URL for your definition and select **TRY IT**.
|
|
|
53
45
|
- High-level grouping in side menu with the [`x-tagGroups`](https://redocly.com/docs/realm/content/api-docs/openapi-extensions/x-tag-groups) specification extension
|
|
54
46
|
- [Simple integration with React](https://redocly.com/docs/redoc/v3.x/deployment/react)
|
|
55
47
|
- Code samples support (with the `x-codeSamples` specification extension) <br>
|
|
56
|
-
|
|
57
48
|
|
|
58
49
|
## Usage
|
|
59
50
|
|
|
@@ -121,7 +112,7 @@ with support for specifications like SOAP and additional features including:
|
|
|
121
112
|
|
|
122
113
|
A sample of the organizations using Redocly tools in the wild:
|
|
123
114
|
|
|
124
|
-
- [Rebilly](https://
|
|
115
|
+
- [Rebilly](https://www.rebilly.com/catalog/all)
|
|
125
116
|
- [Docker Engine](https://docs.docker.com/reference/api/engine/version/v1.56/)
|
|
126
117
|
- [Zuora](https://developer.zuora.com/v1-api-reference/api)
|
|
127
118
|
- [Discourse](https://docs.discourse.org)
|
package/bundles/redoc.d.ts
CHANGED
|
@@ -113,6 +113,7 @@ declare type ApiStore = {
|
|
|
113
113
|
/** From OpenAPI `info.x-logo`. Rendered by the standalone sidebar. */
|
|
114
114
|
logo?: SidebarLogo;
|
|
115
115
|
specType?: ApiSpecType;
|
|
116
|
+
convertedFrom?: string;
|
|
116
117
|
};
|
|
117
118
|
|
|
118
119
|
declare interface AstType {
|
|
@@ -482,7 +483,7 @@ declare type EmptyMessageNode = {
|
|
|
482
483
|
labelTranslationKey?: string;
|
|
483
484
|
};
|
|
484
485
|
|
|
485
|
-
declare type EnterpriseOnlyOptionKey = 'licenseKey' | 'hideReplay' | 'mockServer' | 'corsProxyUrl' | 'oAuth2RedirectURI' | 'feedback' | 'hideInfoMetadata' | 'showSchemaCatalogLinks';
|
|
486
|
+
declare type EnterpriseOnlyOptionKey = 'licenseKey' | 'hideReplay' | 'mockServer' | 'corsProxyUrl' | 'oAuth2RedirectURI' | 'feedback' | 'hideInfoMetadata' | 'showSchemaCatalogLinks' | 'servers';
|
|
486
487
|
|
|
487
488
|
declare type Events = {
|
|
488
489
|
codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
|
|
@@ -1790,6 +1791,7 @@ declare type RedoclyApiDocsInnerProps = {
|
|
|
1790
1791
|
items: ApiItem[];
|
|
1791
1792
|
basePath: string;
|
|
1792
1793
|
markdownAdapter: MarkdownAdapter;
|
|
1794
|
+
options?: RawApiDocsOptions;
|
|
1793
1795
|
telemetryConfig?: Partial<RedocTelemetryConfig>;
|
|
1794
1796
|
initialTelemetry?: InitialTelemetryContext;
|
|
1795
1797
|
};
|