@redocly/reference-docs 2.33.1 → 2.34.0
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/bin/cli/commands/redocly-docs-cli.min.js +71 -71
- package/bin/cli/commands/redocly-docs-cli.min.js.LICENSE.txt +1 -1
- package/dist/console.redocly-reference-docs.min.js +1 -1
- package/dist/oauth2-redirect.js +1 -1
- package/dist/redocly-reference-docs.min.js +385 -385
- package/lib/redoc-lib/src/components/ApiInfo/ApiInfo.js +1 -1
- package/lib/redoc-lib/src/components/index.d.ts +4 -1
- package/lib/redoc-lib/src/components/index.js +1 -1
- package/lib/redoc-lib/src/services/types.d.ts +4 -1
- package/lib-esm/redoc-lib/src/components/ApiInfo/ApiInfo.js +1 -1
- package/lib-esm/redoc-lib/src/components/index.d.ts +4 -1
- package/lib-esm/redoc-lib/src/components/index.js +1 -1
- package/lib-esm/redoc-lib/src/services/types.d.ts +4 -1
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ApiInfo=void 0;var tslib_1=require("tslib"),mobx_react_1=require("mobx-react"),React=(0,tslib_1.__importStar)(require("react")),common_elements_1=require("../../common-elements/"),ExternalDocumentation_1=require("../ExternalDocumentation/ExternalDocumentation"),Markdown_1=require("../Markdown"),DownloadButton_1=require("../DownloadButton"),styled_elements_1=require("./styled.elements");exports.ApiInfo=(0,mobx_react_1.observer)((function(e){var t=e.store,n=t.definition,l=n.info,a=n.externalDocs,
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ApiInfo=void 0;var tslib_1=require("tslib"),mobx_react_1=require("mobx-react"),React=(0,tslib_1.__importStar)(require("react")),common_elements_1=require("../../common-elements/"),ExternalDocumentation_1=require("../ExternalDocumentation/ExternalDocumentation"),Markdown_1=require("../Markdown"),DownloadButton_1=require("../DownloadButton"),RenderHook_1=require("../RenderHook"),styled_elements_1=require("./styled.elements");exports.ApiInfo=(0,mobx_react_1.observer)((function(e){var t=e.store,n=t.definition,l=n.info,a=n.externalDocs,o=t.options,r=l.license&&React.createElement(styled_elements_1.InfoSpan,null,"License:"," ",l.license.identifier?l.license.identifier:React.createElement("a",{href:l.license.url},l.license.name))||null,c=l.contact&&l.contact.url&&React.createElement(styled_elements_1.InfoSpan,null,"URL: ",React.createElement("a",{href:l.contact.url},l.contact.url))||null,i=l.contact&&l.contact.email&&React.createElement(styled_elements_1.InfoSpan,null,l.contact.name||"E-mail",":"," ",React.createElement("a",{href:"mailto:"+l.contact.email},l.contact.email))||null,m=l.termsOfService&&React.createElement(styled_elements_1.InfoSpan,null,React.createElement("a",{href:l.termsOfService},"Terms of Service"))||null,s=l.version&&React.createElement("span",null,"(",l.version,")")||null,u=null==t?void 0:t.options.hooks;return React.createElement(common_elements_1.Section,null,React.createElement(common_elements_1.Row,null,React.createElement(common_elements_1.MiddlePanel,{className:"api-info"},React.createElement(styled_elements_1.ApiHeader,null,l.title," ",s),React.createElement(RenderHook_1.RenderHook,{Hook:null==u?void 0:u.AfterApiTitle,props:{info:l}}),!o.hideDownloadButton&&React.createElement(DownloadButton_1.DownloadButtonWithLabel,{store:t,wrapped:!0}),React.createElement(Markdown_1.StyledMarkdownBlock,null,(l.license||l.contact||l.termsOfService)&&React.createElement(styled_elements_1.InfoSpanBoxWrap,null,React.createElement(styled_elements_1.InfoSpanBox,null,i," ",c," ",r," ",m))||null),React.createElement(Markdown_1.Markdown,{source:l.summary,"data-role":"redoc-summary"}),React.createElement(Markdown_1.Markdown,{source:l.description,"data-role":"redoc-description"}),a&&React.createElement(ExternalDocumentation_1.ExternalDocumentation,{externalDocs:a}))))}));
|
|
2
2
|
//# sourceMappingURL=ApiInfo.js.map
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
export * from './ApiInfo/ApiInfo';
|
|
2
2
|
export * from './ApiLogo/ApiLogo';
|
|
3
|
-
export
|
|
3
|
+
export { OperationItem } from './OperationItem';
|
|
4
|
+
export { SectionItem } from './SectionItem';
|
|
5
|
+
export { ContentItem } from './ContentItem';
|
|
6
|
+
export { ContentItems } from './ContentItems';
|
|
4
7
|
export * from './Schema/';
|
|
5
8
|
export * from './SearchBox/SearchBox';
|
|
6
9
|
export * from './Operation/Operation';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.DropdownWrapper=exports.Example=exports.ExampleValue=exports.PayloadSamples=void 0;var tslib_1=require("tslib");(0,tslib_1.__exportStar)(require("./ApiInfo/ApiInfo"),exports),(0,tslib_1.__exportStar)(require("./ApiLogo/ApiLogo"),exports),(0,
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.DropdownWrapper=exports.Example=exports.ExampleValue=exports.PayloadSamples=exports.ContentItems=exports.ContentItem=exports.SectionItem=exports.OperationItem=void 0;var tslib_1=require("tslib");(0,tslib_1.__exportStar)(require("./ApiInfo/ApiInfo"),exports),(0,tslib_1.__exportStar)(require("./ApiLogo/ApiLogo"),exports);var OperationItem_1=require("./OperationItem");Object.defineProperty(exports,"OperationItem",{enumerable:!0,get:function(){return OperationItem_1.OperationItem}});var SectionItem_1=require("./SectionItem");Object.defineProperty(exports,"SectionItem",{enumerable:!0,get:function(){return SectionItem_1.SectionItem}});var ContentItem_1=require("./ContentItem");Object.defineProperty(exports,"ContentItem",{enumerable:!0,get:function(){return ContentItem_1.ContentItem}});var ContentItems_1=require("./ContentItems");Object.defineProperty(exports,"ContentItems",{enumerable:!0,get:function(){return ContentItems_1.ContentItems}}),(0,tslib_1.__exportStar)(require("./Schema/"),exports),(0,tslib_1.__exportStar)(require("./SearchBox/SearchBox"),exports),(0,tslib_1.__exportStar)(require("./Operation/Operation"),exports),(0,tslib_1.__exportStar)(require("./Loading/Loading"),exports),(0,tslib_1.__exportStar)(require("./JsonViewer"),exports),(0,tslib_1.__exportStar)(require("./Markdown"),exports),(0,tslib_1.__exportStar)(require("./SecuritySchemes/SecuritySchemes"),exports),(0,tslib_1.__exportStar)(require("./Responses/Response"),exports),(0,tslib_1.__exportStar)(require("./Responses/ResponseDetails"),exports),(0,tslib_1.__exportStar)(require("./Responses/ResponseHeaders"),exports),(0,tslib_1.__exportStar)(require("./Responses/ResponsesList"),exports),(0,tslib_1.__exportStar)(require("./Responses/ResponseSummary"),exports),(0,tslib_1.__exportStar)(require("./ResponseSamples/ResponseSamples"),exports);var PayloadSamples_1=require("./PayloadSamples");Object.defineProperty(exports,"PayloadSamples",{enumerable:!0,get:function(){return PayloadSamples_1.PayloadSamples}}),Object.defineProperty(exports,"ExampleValue",{enumerable:!0,get:function(){return PayloadSamples_1.ExampleValue}}),Object.defineProperty(exports,"Example",{enumerable:!0,get:function(){return PayloadSamples_1.Example}}),Object.defineProperty(exports,"DropdownWrapper",{enumerable:!0,get:function(){return PayloadSamples_1.DropdownWrapper}}),(0,tslib_1.__exportStar)(require("./MediaTypeSwitch/MediaTypesSwitch"),exports),(0,tslib_1.__exportStar)(require("./Parameters/Parameters"),exports),(0,tslib_1.__exportStar)(require("./DropdownOrLabel/DropdownOrLabel"),exports),(0,tslib_1.__exportStar)(require("./ErrorBoundary"),exports),(0,tslib_1.__exportStar)(require("./StoreBuilder"),exports),(0,tslib_1.__exportStar)(require("./OptionsProvider"),exports),(0,tslib_1.__exportStar)(require("./SideMenu/"),exports),(0,tslib_1.__exportStar)(require("./StickySidebar/StickyResponsiveSidebar"),exports),(0,tslib_1.__exportStar)(require("./SchemaDefinition/SchemaDefinition"),exports),(0,tslib_1.__exportStar)(require("./SourceCode/SourceCode"),exports),(0,tslib_1.__exportStar)(require("./RequestSamples/RequestSamples"),exports);
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -3,7 +3,7 @@ import type { OpenAPIOperation, OpenAPIParameter, OpenAPIServer, OpenAPITag, Ref
|
|
|
3
3
|
import type { ProStore } from '../../../services';
|
|
4
4
|
import type { OAuth2 } from '../../../services/OAuth2';
|
|
5
5
|
import type { ThemeInterface } from '../theme';
|
|
6
|
-
import type { GroupModel, OperationModel, Sample } from './models';
|
|
6
|
+
import type { ApiInfoModel, GroupModel, OperationModel, Sample } from './models';
|
|
7
7
|
export declare type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
|
|
8
8
|
export declare type MenuItemType = MenuItemGroupType | 'operation';
|
|
9
9
|
/** Generic interface for MenuItems */
|
|
@@ -116,6 +116,9 @@ export interface HookRawHtml {
|
|
|
116
116
|
declare type HookResult = JSX.Element | HookRawHtml | null;
|
|
117
117
|
export declare type HookConfig<T> = (props: T) => HookResult;
|
|
118
118
|
export interface HooksConfig {
|
|
119
|
+
AfterApiTitle?: HookConfig<{
|
|
120
|
+
info: ApiInfoModel;
|
|
121
|
+
}>;
|
|
119
122
|
BeforeOperation?: HookConfig<{
|
|
120
123
|
operation: OperationModel;
|
|
121
124
|
}>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{observer}from"mobx-react";import*as React from"react";import{MiddlePanel,Row,Section}from"../../common-elements/";import{ExternalDocumentation}from"../ExternalDocumentation/ExternalDocumentation";import{Markdown,StyledMarkdownBlock}from"../Markdown";import{DownloadButtonWithLabel}from"../DownloadButton";import{ApiHeader,InfoSpan,InfoSpanBox,InfoSpanBoxWrap}from"./styled.elements";export var ApiInfo=observer((function(e){var t=e.store,n=t.definition,a=n.info,o=n.externalDocs,l=t.options,r=a.license&&React.createElement(InfoSpan,null,"License:"," ",a.license.identifier?a.license.identifier:React.createElement("a",{href:a.license.url},a.license.name))||null,c=a.contact&&a.contact.url&&React.createElement(InfoSpan,null,"URL: ",React.createElement("a",{href:a.contact.url},a.contact.url))||null,
|
|
1
|
+
import{observer}from"mobx-react";import*as React from"react";import{MiddlePanel,Row,Section}from"../../common-elements/";import{ExternalDocumentation}from"../ExternalDocumentation/ExternalDocumentation";import{Markdown,StyledMarkdownBlock}from"../Markdown";import{DownloadButtonWithLabel}from"../DownloadButton";import{RenderHook}from"../RenderHook";import{ApiHeader,InfoSpan,InfoSpanBox,InfoSpanBoxWrap}from"./styled.elements";export var ApiInfo=observer((function(e){var t=e.store,n=t.definition,a=n.info,o=n.externalDocs,l=t.options,r=a.license&&React.createElement(InfoSpan,null,"License:"," ",a.license.identifier?a.license.identifier:React.createElement("a",{href:a.license.url},a.license.name))||null,c=a.contact&&a.contact.url&&React.createElement(InfoSpan,null,"URL: ",React.createElement("a",{href:a.contact.url},a.contact.url))||null,i=a.contact&&a.contact.email&&React.createElement(InfoSpan,null,a.contact.name||"E-mail",":"," ",React.createElement("a",{href:"mailto:"+a.contact.email},a.contact.email))||null,m=a.termsOfService&&React.createElement(InfoSpan,null,React.createElement("a",{href:a.termsOfService},"Terms of Service"))||null,u=a.version&&React.createElement("span",null,"(",a.version,")")||null,s=null==t?void 0:t.options.hooks;return React.createElement(Section,null,React.createElement(Row,null,React.createElement(MiddlePanel,{className:"api-info"},React.createElement(ApiHeader,null,a.title," ",u),React.createElement(RenderHook,{Hook:null==s?void 0:s.AfterApiTitle,props:{info:a}}),!l.hideDownloadButton&&React.createElement(DownloadButtonWithLabel,{store:t,wrapped:!0}),React.createElement(StyledMarkdownBlock,null,(a.license||a.contact||a.termsOfService)&&React.createElement(InfoSpanBoxWrap,null,React.createElement(InfoSpanBox,null,i," ",c," ",r," ",m))||null),React.createElement(Markdown,{source:a.summary,"data-role":"redoc-summary"}),React.createElement(Markdown,{source:a.description,"data-role":"redoc-description"}),o&&React.createElement(ExternalDocumentation,{externalDocs:o}))))}));
|
|
2
2
|
//# sourceMappingURL=ApiInfo.js.map
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
export * from './ApiInfo/ApiInfo';
|
|
2
2
|
export * from './ApiLogo/ApiLogo';
|
|
3
|
-
export
|
|
3
|
+
export { OperationItem } from './OperationItem';
|
|
4
|
+
export { SectionItem } from './SectionItem';
|
|
5
|
+
export { ContentItem } from './ContentItem';
|
|
6
|
+
export { ContentItems } from './ContentItems';
|
|
4
7
|
export * from './Schema/';
|
|
5
8
|
export * from './SearchBox/SearchBox';
|
|
6
9
|
export * from './Operation/Operation';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export*from"./ApiInfo/ApiInfo";export*from"./ApiLogo/ApiLogo";export
|
|
1
|
+
export*from"./ApiInfo/ApiInfo";export*from"./ApiLogo/ApiLogo";export{OperationItem}from"./OperationItem";export{SectionItem}from"./SectionItem";export{ContentItem}from"./ContentItem";export{ContentItems}from"./ContentItems";export*from"./Schema/";export*from"./SearchBox/SearchBox";export*from"./Operation/Operation";export*from"./Loading/Loading";export*from"./JsonViewer";export*from"./Markdown";export*from"./SecuritySchemes/SecuritySchemes";export*from"./Responses/Response";export*from"./Responses/ResponseDetails";export*from"./Responses/ResponseHeaders";export*from"./Responses/ResponsesList";export*from"./Responses/ResponseSummary";export*from"./ResponseSamples/ResponseSamples";export{PayloadSamples,ExampleValue,Example,DropdownWrapper}from"./PayloadSamples";export*from"./MediaTypeSwitch/MediaTypesSwitch";export*from"./Parameters/Parameters";export*from"./DropdownOrLabel/DropdownOrLabel";export*from"./ErrorBoundary";export*from"./StoreBuilder";export*from"./OptionsProvider";export*from"./SideMenu/";export*from"./StickySidebar/StickyResponsiveSidebar";export*from"./SchemaDefinition/SchemaDefinition";export*from"./SourceCode/SourceCode";export*from"./RequestSamples/RequestSamples";
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
|
@@ -3,7 +3,7 @@ import type { OpenAPIOperation, OpenAPIParameter, OpenAPIServer, OpenAPITag, Ref
|
|
|
3
3
|
import type { ProStore } from '../../../services';
|
|
4
4
|
import type { OAuth2 } from '../../../services/OAuth2';
|
|
5
5
|
import type { ThemeInterface } from '../theme';
|
|
6
|
-
import type { GroupModel, OperationModel, Sample } from './models';
|
|
6
|
+
import type { ApiInfoModel, GroupModel, OperationModel, Sample } from './models';
|
|
7
7
|
export declare type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
|
|
8
8
|
export declare type MenuItemType = MenuItemGroupType | 'operation';
|
|
9
9
|
/** Generic interface for MenuItems */
|
|
@@ -116,6 +116,9 @@ export interface HookRawHtml {
|
|
|
116
116
|
declare type HookResult = JSX.Element | HookRawHtml | null;
|
|
117
117
|
export declare type HookConfig<T> = (props: T) => HookResult;
|
|
118
118
|
export interface HooksConfig {
|
|
119
|
+
AfterApiTitle?: HookConfig<{
|
|
120
|
+
info: ApiInfoModel;
|
|
121
|
+
}>;
|
|
119
122
|
BeforeOperation?: HookConfig<{
|
|
120
123
|
operation: OperationModel;
|
|
121
124
|
}>;
|