@redocly/openapi-docs 3.0.0-alpha.55.patch.1 → 3.0.0-alpha.56.patch.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/dist/console.redocly-openapi-docs.min.js +2 -2
- package/dist/oauth2-redirect.js +1 -1
- package/dist/redocly-openapi-docs.min.js +1184 -1122
- package/lib/components/Endpoint/Endpoint.js +1 -1
- package/lib/components/Parameters/BodyContent.d.ts +1 -0
- package/lib/components/Parameters/BodyContent.js +1 -1
- package/lib/components/Parameters/DropdownWithinHeader.d.ts +4 -1
- package/lib/components/Parameters/DropdownWithinHeader.js +6 -1
- package/lib/components/Parameters/Parameters.js +1 -1
- package/lib/components/RedoclyOpenAPIDocs/styled.js +1 -1
- package/lib/components/common/Dropdown/styled.js +4 -5
- package/lib/components/pluggable/RedocRequestBody.js +1 -1
- package/lib/components/shared/MimeLabel.js +1 -4
- package/lib/events/types.d.ts +6 -5
- package/lib/events/types.js +1 -1
- package/lib/models/request.js +1 -1
- package/lib/models/types.d.ts +1 -1
- package/lib-esm/components/Endpoint/Endpoint.js +1 -1
- package/lib-esm/components/Parameters/BodyContent.d.ts +1 -0
- package/lib-esm/components/Parameters/BodyContent.js +1 -1
- package/lib-esm/components/Parameters/DropdownWithinHeader.d.ts +4 -1
- package/lib-esm/components/Parameters/DropdownWithinHeader.js +6 -1
- package/lib-esm/components/Parameters/Parameters.js +1 -1
- package/lib-esm/components/RedoclyOpenAPIDocs/styled.js +1 -1
- package/lib-esm/components/common/Dropdown/styled.js +4 -5
- package/lib-esm/components/pluggable/RedocRequestBody.js +1 -1
- package/lib-esm/components/shared/MimeLabel.js +1 -4
- package/lib-esm/events/types.d.ts +6 -5
- package/lib-esm/events/types.js +1 -1
- package/lib-esm/models/request.js +1 -1
- package/lib-esm/models/types.d.ts +1 -1
- package/package.json +4 -4
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,n){void 0===n&&(n=r);var
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,n){void 0===n&&(n=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,n,o)}:function(e,t,r,n){void 0===n&&(n=r),e[n]=t[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&__createBinding(t,e,r);return __setModuleDefault(t,e),t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Endpoint=void 0;const react_1=__importStar(require("react")),recoil_1=require("recoil"),Panel_1=require("../Panel"),Console_1=require("../rightPanel/Console"),events_1=require("../../events"),ServerList_1=require("./ServerList"),Summary_1=require("./Summary"),store_1=require("../../recoil/store"),Endpoint=({operation:e,hideHostname:t})=>{const[r,n]=(0,react_1.useState)(!1),o=(0,recoil_1.useRecoilValue)(store_1.globalOptionsSelector),a=()=>{var t,a;const i=!r;n(i),null===(a=null===(t=o.events)||void 0===t?void 0:t.tryItToggle)||void 0===a||a.call(t,{eventType:events_1.AnalyticsEventType.tryItToggle,resource:"Redocly_OperationTryIt",action:o.unstable_tryItButtonOverride?"NavigatedOverrideLink":i?"Opened":"Closed",operationId:e.operationId,operationPath:e.path,operationHttpVerb:e.httpVerb,operationSummary:e.description})};return react_1.default.createElement(react_1.default.Fragment,null,r?react_1.default.createElement(react_1.default.Fragment,null,react_1.default.createElement(Console_1.Console,{operation:e,onClose:a})):react_1.default.createElement(Panel_1.CodePanel,{className:"panel-try-it",header:({toggle:t,expanded:r})=>{const n=!!o.showConsole&&!e.hideTryItPanel;return react_1.default.createElement(Summary_1.Summary,{operation:e,expanded:r,toggle:t,showConsole:n,onToggleConsole:a,tryItOverride:o.unstable_tryItButtonOverride})},expanded:!1},react_1.default.createElement(ServerList_1.ServerList,{servers:e.servers,path:e.path,expandVariables:Boolean(o.expandDefaultServerVariables),hideHostname:t||Boolean(o.hideHostname)})))};exports.Endpoint=Endpoint;
|
|
2
2
|
//# sourceMappingURL=Endpoint.js.map
|
|
@@ -3,6 +3,7 @@ import type { MediaContentModel } from '../../models';
|
|
|
3
3
|
interface BodyContentProps {
|
|
4
4
|
content: MediaContentModel;
|
|
5
5
|
description?: string | GenericObject;
|
|
6
|
+
required?: boolean;
|
|
6
7
|
}
|
|
7
8
|
export declare const BodyContent: React.NamedExoticComponent<BodyContentProps>;
|
|
8
9
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,n){void 0===n&&(n=r);var
|
|
1
|
+
"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,n){void 0===n&&(n=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,n,i)}:function(e,t,r,n){void 0===n&&(n=r),e[n]=t[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&__createBinding(t,e,r);return __setModuleDefault(t,e),t},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.BodyContent=void 0;const react_1=__importStar(require("react")),styled_components_1=__importDefault(require("styled-components")),MediaTypeSwitch_1=require("../MediaTypeSwitch"),Markdown_1=require("../Markdown"),Fields_1=require("../Fields"),Schema_1=require("../Schema"),DropdownWithinHeader_1=require("./DropdownWithinHeader");function BodyContentComponent({content:e,description:t,required:r}){const{isRequestType:n}=e;return react_1.default.createElement(MediaTypeSwitch_1.MediaTypesSwitch,{content:e,renderDropdown:e=>react_1.default.createElement(DropdownWithinHeader_1.DropdownWithinHeader,Object.assign({required:r},e))},(({schema:e,examples:r,operation:i})=>react_1.default.createElement(react_1.default.Fragment,null,(void 0!==t||(null==e?void 0:e.constraints))&&react_1.default.createElement(Description,null,void 0!==t&&react_1.default.createElement(Markdown_1.Markdown,{source:t}),"object"===(null==e?void 0:e.type)&&react_1.default.createElement(Fields_1.ConstraintsView,{constraints:(null==e?void 0:e.constraints)||[]})),react_1.default.createElement(Schema_1.Schema,{skipReadOnly:n,skipWriteOnly:!n,key:"schema",schema:e,examples:r,operation:i}))))}exports.BodyContent=(0,react_1.memo)(BodyContentComponent);const Description=styled_components_1.default.div`
|
|
2
2
|
margin-bottom: calc(var(--spacing-unit) * 4);
|
|
3
3
|
`;
|
|
4
4
|
//# sourceMappingURL=BodyContent.js.map
|
|
@@ -1,2 +1,5 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
|
|
2
|
+
import type { DropdownOrLabelProps } from '../DropdownOrLabel/DropdownOrLabel';
|
|
3
|
+
export declare function DropdownWithinHeader({ required, ...props }: DropdownOrLabelProps & {
|
|
4
|
+
required?: boolean;
|
|
5
|
+
}): JSX.Element;
|
|
@@ -1,2 +1,7 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DropdownWithinHeader=void 0;const react_1=__importDefault(require("react")),common_1=require("../common"),DropdownOrLabel_1=require("../DropdownOrLabel"),Dropdown_1=require("../common/Dropdown");function DropdownWithinHeader(e){return react_1.default.createElement(common_1.FieldsGroupHeader,{key:"header","data-cy":"request-body-header"},"Request Body schema: ",react_1.default.createElement(DropdownOrLabel_1.DropdownOrLabel,Object.assign({},
|
|
1
|
+
"use strict";var __rest=this&&this.__rest||function(e,o){var t={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&o.indexOf(r)<0&&(t[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var n=0;for(r=Object.getOwnPropertySymbols(e);n<r.length;n++)o.indexOf(r[n])<0&&Object.prototype.propertyIsEnumerable.call(e,r[n])&&(t[r[n]]=e[r[n]])}return t},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DropdownWithinHeader=void 0;const react_1=__importDefault(require("react")),styled_components_1=__importDefault(require("styled-components")),common_1=require("../common"),DropdownOrLabel_1=require("../DropdownOrLabel"),Dropdown_1=require("../common/Dropdown");function DropdownWithinHeader(e){var{required:o}=e,t=__rest(e,["required"]);const r="boolean"==typeof o&&!!o,n="boolean"==typeof o&&!o;return react_1.default.createElement(common_1.FieldsGroupHeader,{key:"header","data-cy":"request-body-header"},"Request Body schema: ",react_1.default.createElement(DropdownOrLabel_1.DropdownOrLabel,Object.assign({},t,{Dropdown:Dropdown_1.SchemaMimeTypeDropdown})),r&&react_1.default.createElement(RequiredBody,null,"required"),n&&react_1.default.createElement(OptionalBody,null,"optional"))}exports.DropdownWithinHeader=DropdownWithinHeader;const commonStyles="\n text-transform: lowercase;\n font-size: var(--schema-labels-font-size);\n font-family: var(--font-family-monospaced);\n font-weight: var(--font-weight-regular);\n",RequiredBody=(0,styled_components_1.default)(common_1.RequiredLabel)`
|
|
2
|
+
${commonStyles}
|
|
3
|
+
`,OptionalBody=(0,styled_components_1.default)("div")`
|
|
4
|
+
${commonStyles}
|
|
5
|
+
color: var(--text-color-secondary);
|
|
6
|
+
`;
|
|
2
7
|
//# sourceMappingURL=DropdownWithinHeader.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Parameters=void 0;const react_1=__importDefault(require("react")),BodyContent_1=require("./BodyContent"),ParametersGroup_1=require("./ParametersGroup"),PARAM_PLACES=["path","query","cookie","header"];function Parameters({body:e,parameters:t=[]}){if(void 0===e&&void 0===t)return null;const r=(e=>{const t={};return e.forEach((e=>{safePush(t,e.in,e)})),t})(t),a=t.length>0?PARAM_PLACES:[],o
|
|
1
|
+
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Parameters=void 0;const react_1=__importDefault(require("react")),BodyContent_1=require("./BodyContent"),ParametersGroup_1=require("./ParametersGroup"),PARAM_PLACES=["path","query","cookie","header"];function Parameters({body:e,parameters:t=[]}){if(void 0===e&&void 0===t)return null;const r=(e=>{const t={};return e.forEach((e=>{safePush(t,e.in,e)})),t})(t),a=t.length>0?PARAM_PLACES:[],{content:o,description:n,required:u}=e||{};return react_1.default.createElement(react_1.default.Fragment,null,a.map((e=>react_1.default.createElement(ParametersGroup_1.ParametersGroup,{key:e,place:e,parameters:r[e]}))),o&&react_1.default.createElement(BodyContent_1.BodyContent,{content:o,description:n,required:u}))}function safePush(e,t="",r){e[t]||(e[t]=[]),e[t].push(r)}exports.Parameters=Parameters;
|
|
2
2
|
//# sourceMappingURL=Parameters.js.map
|
|
@@ -70,7 +70,7 @@
|
|
|
70
70
|
(
|
|
71
71
|
100% - min(100% - var(--sidebar-width) - var(--layout-controls-width), var(${e})) -
|
|
72
72
|
var(--sidebar-width) + var(--layout-controls-width)
|
|
73
|
-
) / 2
|
|
73
|
+
) / 2 - 4px /* -4px fix overlap for panels */
|
|
74
74
|
);
|
|
75
75
|
`;exports.BackgroundStubFix=styled_components_1.default.div`
|
|
76
76
|
position: absolute;
|
|
@@ -23,8 +23,7 @@
|
|
|
23
23
|
min-width: 90px;
|
|
24
24
|
height: 36px;
|
|
25
25
|
outline: none;
|
|
26
|
-
display:
|
|
27
|
-
align-items: center;
|
|
26
|
+
display: inline-block;
|
|
28
27
|
color: var(--docs-dropdown-text-color);
|
|
29
28
|
border-radius: var(--border-radius-md);
|
|
30
29
|
padding: var(--docs-dropdown-padding);
|
|
@@ -60,7 +59,7 @@
|
|
|
60
59
|
|
|
61
60
|
color: var(--text-secondary);
|
|
62
61
|
line-height: inherit;
|
|
63
|
-
font-size:
|
|
62
|
+
font-size: var(--font-size-base);
|
|
64
63
|
font-family: inherit;
|
|
65
64
|
padding: var(--docs-dropdown-padding);
|
|
66
65
|
${({variant:o})=>"dark"===o?darkDropdownStyle:""};
|
|
@@ -73,8 +72,8 @@
|
|
|
73
72
|
label {
|
|
74
73
|
padding: 0 26px 0 4px;
|
|
75
74
|
background: transparent;
|
|
76
|
-
font-size:
|
|
77
|
-
font-weight:
|
|
75
|
+
font-size: var(--font-size-base);
|
|
76
|
+
font-weight: var(--font-weight-regular);
|
|
78
77
|
appearance: none;
|
|
79
78
|
height: auto;
|
|
80
79
|
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.RedocRequestBody=void 0;const react_1=__importDefault(require("react")),recoil_1=require("recoil"),models_1=require("../../models"),common_1=require("../common"),styled_components_1=require("./styled.components"),PayloadSamples_1=require("../PayloadSamples"),Parameters_1=require("../Parameters"),store_1=require("../../recoil/store"),app_1=require("../..//recoil/app"),RedocRequestBody=({pointer:e,hideSamples:t})=>{const{options:
|
|
1
|
+
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.RedocRequestBody=void 0;const react_1=__importDefault(require("react")),recoil_1=require("recoil"),models_1=require("../../models"),common_1=require("../common"),styled_components_1=require("./styled.components"),PayloadSamples_1=require("../PayloadSamples"),Parameters_1=require("../Parameters"),store_1=require("../../recoil/store"),app_1=require("../..//recoil/app"),RedocRequestBody=({pointer:e,hideSamples:t})=>{const{options:r,parser:o}=(0,recoil_1.useRecoilValue)(store_1.globalStoreSelector),a=(0,recoil_1.useRecoilValue)(app_1.layoutSelector),l=(0,models_1.getOperation)(o,{pointer:e,pathName:"",httpVerb:"",pathParameters:[],pathServers:[],isWebhook:!1,responses:{}},void 0,r,""),{content:s,description:n,required:c}=(0,models_1.getRequestBody)({parser:o,infoOrRef:{$ref:e},options:r,operation:l})||{},u=t?styled_components_1.FullWidthPanel:common_1.SamplesMiddlePanel;return react_1.default.createElement(common_1.Row,{layout:a},react_1.default.createElement(u,null,s&&react_1.default.createElement(Parameters_1.BodyContent,{content:s,description:n,required:c})),!t&&react_1.default.createElement(common_1.SamplesPanel,null,react_1.default.createElement(styled_components_1.SamplesWrap,null,s&&react_1.default.createElement(PayloadSamples_1.PayloadSamples,{content:s})))||react_1.default.createElement("span",null))};exports.RedocRequestBody=RedocRequestBody;
|
|
2
2
|
//# sourceMappingURL=RedocRequestBody.js.map
|
|
@@ -1,14 +1,11 @@
|
|
|
1
1
|
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.MimeLabel=void 0;const styled_components_1=__importDefault(require("styled-components"));exports.MimeLabel=styled_components_1.default.div`
|
|
2
|
-
display: flex;
|
|
3
|
-
align-items: center;
|
|
4
2
|
background-color: var(--panel-samples-dropdown-background-color);
|
|
5
3
|
color: var(--panel-samples-text-color);
|
|
6
4
|
font-family: var(--code-font-family);
|
|
7
5
|
margin-bottom: 0;
|
|
8
6
|
height: 36px;
|
|
9
7
|
padding: var(--docs-dropdown-padding);
|
|
10
|
-
font-size:
|
|
11
|
-
line-height: 16px;
|
|
8
|
+
font-size: var(--font-size-base);
|
|
12
9
|
border: var(--panel-samples-dropdown-border);
|
|
13
10
|
border-radius: var(--panel-border-radius);
|
|
14
11
|
`;
|
package/lib/events/types.d.ts
CHANGED
|
@@ -24,14 +24,14 @@ export declare enum AnalyticsEventType {
|
|
|
24
24
|
CodeSampleCopied = "CodeSampleCopied",
|
|
25
25
|
OperationServerExpanded = "OperationServerExpanded",
|
|
26
26
|
PanelToggle = "PanelToggle",
|
|
27
|
-
|
|
27
|
+
tryItToggle = "TryItToggle",
|
|
28
28
|
TryItSent = "TryItSent",
|
|
29
29
|
TargetServerSwitched = "TargetServerSwitched"
|
|
30
30
|
}
|
|
31
31
|
export interface AnalyticsEvent {
|
|
32
32
|
eventType: AnalyticsEventType;
|
|
33
33
|
resource: 'Redocly_CodeSample' | 'Redocly_Operation' | 'Redocly_OperationTryIt';
|
|
34
|
-
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
|
|
34
|
+
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'Closed' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
|
|
35
35
|
operationId?: string;
|
|
36
36
|
operationPath: string;
|
|
37
37
|
operationHttpVerb: string;
|
|
@@ -49,7 +49,8 @@ export interface CodeSamplesCopiedEvent extends AnalyticsEvent {
|
|
|
49
49
|
exampleId?: string;
|
|
50
50
|
exampleMimeType?: string;
|
|
51
51
|
}
|
|
52
|
-
type
|
|
52
|
+
type TryItSentEvent = AnalyticsEvent;
|
|
53
|
+
type tryItToggleEvent = AnalyticsEvent;
|
|
53
54
|
export interface PanelToggleEvent extends AnalyticsEvent {
|
|
54
55
|
panelType: 'request' | 'responses' | 'request-samples' | 'response-samples';
|
|
55
56
|
state: 'expanded' | 'collapsed';
|
|
@@ -64,8 +65,8 @@ export interface TargetServerSwitchedEvent extends AnalyticsEvent {
|
|
|
64
65
|
export type Events = {
|
|
65
66
|
codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
|
|
66
67
|
codeSamplesCopy?: (event: CodeSamplesCopiedEvent) => void;
|
|
67
|
-
|
|
68
|
-
tryItSent?: (event:
|
|
68
|
+
tryItToggle?: (event: tryItToggleEvent) => void;
|
|
69
|
+
tryItSent?: (event: TryItSentEvent) => void;
|
|
69
70
|
panelToggle?: (event: PanelToggleEvent) => void;
|
|
70
71
|
targetServerSwitch?: (event: TargetServerSwitchedEvent) => void;
|
|
71
72
|
};
|
package/lib/events/types.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var AnalyticsEventType;Object.defineProperty(exports,"__esModule",{value:!0}),exports.AnalyticsEventType=void 0,function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.
|
|
1
|
+
"use strict";var AnalyticsEventType;Object.defineProperty(exports,"__esModule",{value:!0}),exports.AnalyticsEventType=void 0,function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.tryItToggle="TryItToggle",e.TryItSent="TryItSent",e.TargetServerSwitched="TargetServerSwitched"}(AnalyticsEventType=exports.AnalyticsEventType||(exports.AnalyticsEventType={}));
|
|
2
2
|
//# sourceMappingURL=types.js.map
|
package/lib/models/request.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getRequestBody=void 0;const utils_1=require("../utils"),mediaContent_1=require("./mediaContent");function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:i,operation:n}){const{resolved:r}=e.deref(t),s=(0,utils_1.getValueFromMdParsedExtension)(r,"description")||"",u
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getRequestBody=void 0;const utils_1=require("../utils"),mediaContent_1=require("./mediaContent");function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:i,operation:n}){const{resolved:r}=e.deref(t),s=(0,utils_1.getValueFromMdParsedExtension)(r,"description")||"",u=r.required;let d;const a=!i,p=(0,utils_1.getContentWithLegacyExamples)(r);return void 0!==p&&(d=(0,mediaContent_1.getMediaContent)({parser:e,info:p,isRequestType:a,options:o,data:{operation:n,type:"request",absolutePointer:t.$ref||utils_1.JsonPointer.join(n.pointer,["requestBody"])}})),{description:s,required:u,content:d}}exports.getRequestBody=getRequestBody;
|
|
2
2
|
//# sourceMappingURL=request.js.map
|
package/lib/models/types.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React,{useState}from"react";import{useRecoilValue}from"recoil";import{CodePanel}from"../Panel";import{Console}from"../rightPanel/Console";import{AnalyticsEventType}from"../../events";import{ServerList}from"./ServerList";import{Summary}from"./Summary";import{globalOptionsSelector}from"../../recoil/store";export const Endpoint=({operation:e,hideHostname:t})=>{const[o,r]=useState(!1),a=useRecoilValue(globalOptionsSelector),n=()=>{var t,n;const l=!o;r(l),
|
|
1
|
+
import React,{useState}from"react";import{useRecoilValue}from"recoil";import{CodePanel}from"../Panel";import{Console}from"../rightPanel/Console";import{AnalyticsEventType}from"../../events";import{ServerList}from"./ServerList";import{Summary}from"./Summary";import{globalOptionsSelector}from"../../recoil/store";export const Endpoint=({operation:e,hideHostname:t})=>{const[o,r]=useState(!1),a=useRecoilValue(globalOptionsSelector),n=()=>{var t,n;const l=!o;r(l),null===(n=null===(t=a.events)||void 0===t?void 0:t.tryItToggle)||void 0===n||n.call(t,{eventType:AnalyticsEventType.tryItToggle,resource:"Redocly_OperationTryIt",action:a.unstable_tryItButtonOverride?"NavigatedOverrideLink":l?"Opened":"Closed",operationId:e.operationId,operationPath:e.path,operationHttpVerb:e.httpVerb,operationSummary:e.description})};return React.createElement(React.Fragment,null,o?React.createElement(React.Fragment,null,React.createElement(Console,{operation:e,onClose:n})):React.createElement(CodePanel,{className:"panel-try-it",header:({toggle:t,expanded:o})=>{const r=!!a.showConsole&&!e.hideTryItPanel;return React.createElement(Summary,{operation:e,expanded:o,toggle:t,showConsole:r,onToggleConsole:n,tryItOverride:a.unstable_tryItButtonOverride})},expanded:!1},React.createElement(ServerList,{servers:e.servers,path:e.path,expandVariables:Boolean(a.expandDefaultServerVariables),hideHostname:t||Boolean(a.hideHostname)})))};
|
|
2
2
|
//# sourceMappingURL=Endpoint.js.map
|
|
@@ -3,6 +3,7 @@ import type { MediaContentModel } from '../../models';
|
|
|
3
3
|
interface BodyContentProps {
|
|
4
4
|
content: MediaContentModel;
|
|
5
5
|
description?: string | GenericObject;
|
|
6
|
+
required?: boolean;
|
|
6
7
|
}
|
|
7
8
|
export declare const BodyContent: React.NamedExoticComponent<BodyContentProps>;
|
|
8
9
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import React,{memo}from"react";import styled from"styled-components";import{MediaTypesSwitch}from"../MediaTypeSwitch";import{Markdown}from"../Markdown";import{ConstraintsView}from"../Fields";import{Schema}from"../Schema";import{DropdownWithinHeader}from"./DropdownWithinHeader";function BodyContentComponent({content:e,description:t}){const{isRequestType:o}=e;return React.createElement(MediaTypesSwitch,{content:e,renderDropdown:DropdownWithinHeader},(({schema:e,examples:n,operation:r})=>React.createElement(React.Fragment,null,(void 0!==t||(null==e?void 0:e.constraints))&&React.createElement(Description,null,void 0!==t&&React.createElement(Markdown,{source:t}),"object"===(null==e?void 0:e.type)&&React.createElement(ConstraintsView,{constraints:(null==e?void 0:e.constraints)||[]})),React.createElement(Schema,{skipReadOnly:o,skipWriteOnly:!o,key:"schema",schema:e,examples:n,operation:r}))))}export const BodyContent=memo(BodyContentComponent);const Description=styled.div`
|
|
1
|
+
import React,{memo}from"react";import styled from"styled-components";import{MediaTypesSwitch}from"../MediaTypeSwitch";import{Markdown}from"../Markdown";import{ConstraintsView}from"../Fields";import{Schema}from"../Schema";import{DropdownWithinHeader}from"./DropdownWithinHeader";function BodyContentComponent({content:e,description:t,required:n}){const{isRequestType:o}=e;return React.createElement(MediaTypesSwitch,{content:e,renderDropdown:e=>React.createElement(DropdownWithinHeader,Object.assign({required:n},e))},(({schema:e,examples:n,operation:r})=>React.createElement(React.Fragment,null,(void 0!==t||(null==e?void 0:e.constraints))&&React.createElement(Description,null,void 0!==t&&React.createElement(Markdown,{source:t}),"object"===(null==e?void 0:e.type)&&React.createElement(ConstraintsView,{constraints:(null==e?void 0:e.constraints)||[]})),React.createElement(Schema,{skipReadOnly:o,skipWriteOnly:!o,key:"schema",schema:e,examples:n,operation:r}))))}export const BodyContent=memo(BodyContentComponent);const Description=styled.div`
|
|
2
2
|
margin-bottom: calc(var(--spacing-unit) * 4);
|
|
3
3
|
`;
|
|
4
4
|
//# sourceMappingURL=BodyContent.js.map
|
|
@@ -1,2 +1,5 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
|
-
|
|
2
|
+
import type { DropdownOrLabelProps } from '../DropdownOrLabel/DropdownOrLabel';
|
|
3
|
+
export declare function DropdownWithinHeader({ required, ...props }: DropdownOrLabelProps & {
|
|
4
|
+
required?: boolean;
|
|
5
|
+
}): JSX.Element;
|
|
@@ -1,2 +1,7 @@
|
|
|
1
|
-
import React from"react";import{FieldsGroupHeader}from"../common";import{DropdownOrLabel}from"../DropdownOrLabel";import{SchemaMimeTypeDropdown}from"../common/Dropdown";export function DropdownWithinHeader(e){return React.createElement(FieldsGroupHeader,{key:"header","data-cy":"request-body-header"},"Request Body schema: ",React.createElement(DropdownOrLabel,Object.assign({},
|
|
1
|
+
var __rest=this&&this.__rest||function(e,o){var r={};for(var t in e)Object.prototype.hasOwnProperty.call(e,t)&&o.indexOf(t)<0&&(r[t]=e[t]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var n=0;for(t=Object.getOwnPropertySymbols(e);n<t.length;n++)o.indexOf(t[n])<0&&Object.prototype.propertyIsEnumerable.call(e,t[n])&&(r[t[n]]=e[t[n]])}return r};import React from"react";import styled from"styled-components";import{FieldsGroupHeader,RequiredLabel}from"../common";import{DropdownOrLabel}from"../DropdownOrLabel";import{SchemaMimeTypeDropdown}from"../common/Dropdown";export function DropdownWithinHeader(e){var{required:o}=e,r=__rest(e,["required"]);const t="boolean"==typeof o&&!!o,n="boolean"==typeof o&&!o;return React.createElement(FieldsGroupHeader,{key:"header","data-cy":"request-body-header"},"Request Body schema: ",React.createElement(DropdownOrLabel,Object.assign({},r,{Dropdown:SchemaMimeTypeDropdown})),t&&React.createElement(RequiredBody,null,"required"),n&&React.createElement(OptionalBody,null,"optional"))}const commonStyles="\n text-transform: lowercase;\n font-size: var(--schema-labels-font-size);\n font-family: var(--font-family-monospaced);\n font-weight: var(--font-weight-regular);\n",RequiredBody=styled(RequiredLabel)`
|
|
2
|
+
${commonStyles}
|
|
3
|
+
`,OptionalBody=styled("div")`
|
|
4
|
+
${commonStyles}
|
|
5
|
+
color: var(--text-color-secondary);
|
|
6
|
+
`;
|
|
2
7
|
//# sourceMappingURL=DropdownWithinHeader.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React from"react";import{BodyContent}from"./BodyContent";import{ParametersGroup}from"./ParametersGroup";const PARAM_PLACES=["path","query","cookie","header"];export function Parameters({body:e,parameters:t=[]}){if(void 0===e&&void 0===t)return null;const r=(e=>{const t={};return e.forEach((e=>{safePush(t,e.in,e)})),t})(t),o=t.length>0?PARAM_PLACES:[],n
|
|
1
|
+
import React from"react";import{BodyContent}from"./BodyContent";import{ParametersGroup}from"./ParametersGroup";const PARAM_PLACES=["path","query","cookie","header"];export function Parameters({body:e,parameters:t=[]}){if(void 0===e&&void 0===t)return null;const r=(e=>{const t={};return e.forEach((e=>{safePush(t,e.in,e)})),t})(t),o=t.length>0?PARAM_PLACES:[],{content:n,description:a,required:c}=e||{};return React.createElement(React.Fragment,null,o.map((e=>React.createElement(ParametersGroup,{key:e,place:e,parameters:r[e]}))),n&&React.createElement(BodyContent,{content:n,description:a,required:c}))}function safePush(e,t="",r){e[t]||(e[t]=[]),e[t].push(r)}
|
|
2
2
|
//# sourceMappingURL=Parameters.js.map
|
|
@@ -70,7 +70,7 @@ import{LayoutVariant}from"@redocly/theme";import styled,{createGlobalStyle,css}f
|
|
|
70
70
|
(
|
|
71
71
|
100% - min(100% - var(--sidebar-width) - var(--layout-controls-width), var(${a})) -
|
|
72
72
|
var(--sidebar-width) + var(--layout-controls-width)
|
|
73
|
-
) / 2
|
|
73
|
+
) / 2 - 4px /* -4px fix overlap for panels */
|
|
74
74
|
);
|
|
75
75
|
`;export const BackgroundStubFix=styled.div`
|
|
76
76
|
position: absolute;
|
|
@@ -23,8 +23,7 @@ import styled,{css}from"styled-components";import{Dropdown as DropdownComponent}
|
|
|
23
23
|
min-width: 90px;
|
|
24
24
|
height: 36px;
|
|
25
25
|
outline: none;
|
|
26
|
-
display:
|
|
27
|
-
align-items: center;
|
|
26
|
+
display: inline-block;
|
|
28
27
|
color: var(--docs-dropdown-text-color);
|
|
29
28
|
border-radius: var(--border-radius-md);
|
|
30
29
|
padding: var(--docs-dropdown-padding);
|
|
@@ -60,7 +59,7 @@ import styled,{css}from"styled-components";import{Dropdown as DropdownComponent}
|
|
|
60
59
|
|
|
61
60
|
color: var(--text-secondary);
|
|
62
61
|
line-height: inherit;
|
|
63
|
-
font-size:
|
|
62
|
+
font-size: var(--font-size-base);
|
|
64
63
|
font-family: inherit;
|
|
65
64
|
padding: var(--docs-dropdown-padding);
|
|
66
65
|
${({variant:o})=>"dark"===o?darkDropdownStyle:""};
|
|
@@ -73,8 +72,8 @@ import styled,{css}from"styled-components";import{Dropdown as DropdownComponent}
|
|
|
73
72
|
label {
|
|
74
73
|
padding: 0 26px 0 4px;
|
|
75
74
|
background: transparent;
|
|
76
|
-
font-size:
|
|
77
|
-
font-weight:
|
|
75
|
+
font-size: var(--font-size-base);
|
|
76
|
+
font-weight: var(--font-weight-regular);
|
|
78
77
|
appearance: none;
|
|
79
78
|
height: auto;
|
|
80
79
|
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React from"react";import{useRecoilValue}from"recoil";import{getRequestBody,getOperation}from"../../models";import{Row,SamplesMiddlePanel,SamplesPanel}from"../common";import{SamplesWrap,FullWidthPanel}from"./styled.components";import{PayloadSamples}from"../PayloadSamples";import{BodyContent}from"../Parameters";import{globalStoreSelector}from"../../recoil/store";import{layoutSelector}from"../..//recoil/app";export const RedocRequestBody=({pointer:e,hideSamples:t})=>{const{options:o,parser:
|
|
1
|
+
import React from"react";import{useRecoilValue}from"recoil";import{getRequestBody,getOperation}from"../../models";import{Row,SamplesMiddlePanel,SamplesPanel}from"../common";import{SamplesWrap,FullWidthPanel}from"./styled.components";import{PayloadSamples}from"../PayloadSamples";import{BodyContent}from"../Parameters";import{globalStoreSelector}from"../../recoil/store";import{layoutSelector}from"../..//recoil/app";export const RedocRequestBody=({pointer:e,hideSamples:t})=>{const{options:o,parser:r}=useRecoilValue(globalStoreSelector),a=useRecoilValue(layoutSelector),l=getOperation(r,{pointer:e,pathName:"",httpVerb:"",pathParameters:[],pathServers:[],isWebhook:!1,responses:{}},void 0,o,""),{content:n,description:m,required:p}=getRequestBody({parser:r,infoOrRef:{$ref:e},options:o,operation:l})||{},c=t?FullWidthPanel:SamplesMiddlePanel;return React.createElement(Row,{layout:a},React.createElement(c,null,n&&React.createElement(BodyContent,{content:n,description:m,required:p})),!t&&React.createElement(SamplesPanel,null,React.createElement(SamplesWrap,null,n&&React.createElement(PayloadSamples,{content:n})))||React.createElement("span",null))};
|
|
2
2
|
//# sourceMappingURL=RedocRequestBody.js.map
|
|
@@ -1,14 +1,11 @@
|
|
|
1
1
|
import styled from"styled-components";export const MimeLabel=styled.div`
|
|
2
|
-
display: flex;
|
|
3
|
-
align-items: center;
|
|
4
2
|
background-color: var(--panel-samples-dropdown-background-color);
|
|
5
3
|
color: var(--panel-samples-text-color);
|
|
6
4
|
font-family: var(--code-font-family);
|
|
7
5
|
margin-bottom: 0;
|
|
8
6
|
height: 36px;
|
|
9
7
|
padding: var(--docs-dropdown-padding);
|
|
10
|
-
font-size:
|
|
11
|
-
line-height: 16px;
|
|
8
|
+
font-size: var(--font-size-base);
|
|
12
9
|
border: var(--panel-samples-dropdown-border);
|
|
13
10
|
border-radius: var(--panel-border-radius);
|
|
14
11
|
`;
|
|
@@ -24,14 +24,14 @@ export declare enum AnalyticsEventType {
|
|
|
24
24
|
CodeSampleCopied = "CodeSampleCopied",
|
|
25
25
|
OperationServerExpanded = "OperationServerExpanded",
|
|
26
26
|
PanelToggle = "PanelToggle",
|
|
27
|
-
|
|
27
|
+
tryItToggle = "TryItToggle",
|
|
28
28
|
TryItSent = "TryItSent",
|
|
29
29
|
TargetServerSwitched = "TargetServerSwitched"
|
|
30
30
|
}
|
|
31
31
|
export interface AnalyticsEvent {
|
|
32
32
|
eventType: AnalyticsEventType;
|
|
33
33
|
resource: 'Redocly_CodeSample' | 'Redocly_Operation' | 'Redocly_OperationTryIt';
|
|
34
|
-
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
|
|
34
|
+
action: 'LanguageSwitched' | 'PanelToggled' | 'Opened' | 'Closed' | 'NavigatedOverrideLink' | 'Sent' | 'ValidationFailed' | 'CodeSampleCopied' | 'TargetServerSwitched';
|
|
35
35
|
operationId?: string;
|
|
36
36
|
operationPath: string;
|
|
37
37
|
operationHttpVerb: string;
|
|
@@ -49,7 +49,8 @@ export interface CodeSamplesCopiedEvent extends AnalyticsEvent {
|
|
|
49
49
|
exampleId?: string;
|
|
50
50
|
exampleMimeType?: string;
|
|
51
51
|
}
|
|
52
|
-
type
|
|
52
|
+
type TryItSentEvent = AnalyticsEvent;
|
|
53
|
+
type tryItToggleEvent = AnalyticsEvent;
|
|
53
54
|
export interface PanelToggleEvent extends AnalyticsEvent {
|
|
54
55
|
panelType: 'request' | 'responses' | 'request-samples' | 'response-samples';
|
|
55
56
|
state: 'expanded' | 'collapsed';
|
|
@@ -64,8 +65,8 @@ export interface TargetServerSwitchedEvent extends AnalyticsEvent {
|
|
|
64
65
|
export type Events = {
|
|
65
66
|
codeSamplesLanguageSwitch?: (event: CodeSamplesLanguageSwitchedEvent) => void;
|
|
66
67
|
codeSamplesCopy?: (event: CodeSamplesCopiedEvent) => void;
|
|
67
|
-
|
|
68
|
-
tryItSent?: (event:
|
|
68
|
+
tryItToggle?: (event: tryItToggleEvent) => void;
|
|
69
|
+
tryItSent?: (event: TryItSentEvent) => void;
|
|
69
70
|
panelToggle?: (event: PanelToggleEvent) => void;
|
|
70
71
|
targetServerSwitch?: (event: TargetServerSwitchedEvent) => void;
|
|
71
72
|
};
|
package/lib-esm/events/types.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export var AnalyticsEventType;!function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.
|
|
1
|
+
export var AnalyticsEventType;!function(e){e.CodeSampleLanguageSwitched="CodeSampleLanguageSwitched",e.CodeSampleCopied="CodeSampleCopied",e.OperationServerExpanded="OperationServerExpanded",e.PanelToggle="PanelToggle",e.tryItToggle="TryItToggle",e.TryItSent="TryItSent",e.TargetServerSwitched="TargetServerSwitched"}(AnalyticsEventType||(AnalyticsEventType={}));
|
|
2
2
|
//# sourceMappingURL=types.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{getContentWithLegacyExamples,getValueFromMdParsedExtension,JsonPointer}from"../utils";import{getMediaContent}from"./mediaContent";export function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:n,operation:r}){const{resolved:i}=e.deref(t),s=getValueFromMdParsedExtension(i,"description")||"",a
|
|
1
|
+
import{getContentWithLegacyExamples,getValueFromMdParsedExtension,JsonPointer}from"../utils";import{getMediaContent}from"./mediaContent";export function getRequestBody({parser:e,infoOrRef:t,options:o,isEvent:n,operation:r}){const{resolved:i}=e.deref(t),s=getValueFromMdParsedExtension(i,"description")||"",a=i.required;let d;const p=!n,u=getContentWithLegacyExamples(i);return void 0!==u&&(d=getMediaContent({parser:e,info:u,isRequestType:p,options:o,data:{operation:r,type:"request",absolutePointer:t.$ref||JsonPointer.join(r.pointer,["requestBody"])}})),{description:s,required:a,content:d}}
|
|
2
2
|
//# sourceMappingURL=request.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/openapi-docs",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.56.patch.0",
|
|
4
4
|
"description": "Redocly OpenAPI Docs",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"module": "lib-esm/index.js",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"openapi-docs": "bin.js"
|
|
16
16
|
},
|
|
17
17
|
"peerDependencies": {
|
|
18
|
-
"@redocly/theme": ">=0.
|
|
18
|
+
"@redocly/theme": ">=0.9.4",
|
|
19
19
|
"core-js": "^3.1.4",
|
|
20
20
|
"react": "^16.8.4 || ^17.0.0",
|
|
21
21
|
"react-dom": "^16.8.4 || ^17.0.0",
|
|
@@ -64,6 +64,7 @@
|
|
|
64
64
|
"yargs": "^17.3.0"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
|
+
"@redocly/theme": "0.18.3-patch.0",
|
|
67
68
|
"@testing-library/jest-dom": "^5.16.5",
|
|
68
69
|
"@testing-library/react": "^12.1.4",
|
|
69
70
|
"@testing-library/react-hooks": "^8.0.1",
|
|
@@ -116,8 +117,7 @@
|
|
|
116
117
|
"webpack": "^5.88.2",
|
|
117
118
|
"webpack-cli": "^5.1.4",
|
|
118
119
|
"webpack-dev-server": "^4.15.1",
|
|
119
|
-
"workerize-loader": "github:redocly/workerize-loader#webpack-5-dist"
|
|
120
|
-
"@redocly/theme": "0.18.3-patch.0"
|
|
120
|
+
"workerize-loader": "github:redocly/workerize-loader#webpack-5-dist"
|
|
121
121
|
},
|
|
122
122
|
"scripts": {
|
|
123
123
|
"start": "webpack serve --mode=development --hot",
|