Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-09-20 18:58:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: hideRequestPayloadSample (#2436)

Browse Source
This commit is contained in:
Alex Varchuk 2023-10-23 18:36:53 +03:00 committed by GitHub
parent b36a6e27bb
commit bf960612a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap
View File

@ -87,6 +87,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -358,6 +359,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -616,6 +618,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -936,6 +939,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -1219,6 +1223,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -1473,6 +1478,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -1752,6 +1758,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -2061,6 +2068,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -2332,6 +2340,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,
@ -2590,6 +2599,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"hideDownloadButton": false,
"hideFab": false,
"hideHostname": false,
"hideRequestPayloadSample": false,
"hideSchemaPattern": false,
"hideSchemaTitles": false,
"hideSecuritySection": false,

3
src/services/RedocNormalizedOptions.ts
View File

@ -28,6 +28,7 @@ export interface RedocRawOptions {
showExtensions?: boolean | string | string[];
sideNavStyle?: SideNavStyleEnum;
hideSingleRequestSampleTab?: boolean | string;
hideRequestPayloadSample?: boolean;
menuToggle?: boolean | string;
jsonSampleExpandLevel?: number | string | 'all';
hideSchemaTitles?: boolean | string;
@ -231,6 +232,7 @@ export class RedocNormalizedOptions {
showExtensions: boolean | string[];
sideNavStyle: SideNavStyleEnum;
hideSingleRequestSampleTab: boolean;
hideRequestPayloadSample: boolean;
menuToggle: boolean;
jsonSampleExpandLevel: number;
enumSkipQuotes: boolean;
@ -302,6 +304,7 @@ export class RedocNormalizedOptions {
this.showExtensions = RedocNormalizedOptions.normalizeShowExtensions(raw.showExtensions);
this.sideNavStyle = RedocNormalizedOptions.normalizeSideNavStyle(raw.sideNavStyle);
this.hideSingleRequestSampleTab = argValueToBoolean(raw.hideSingleRequestSampleTab);
this.hideRequestPayloadSample = argValueToBoolean(raw.hideRequestPayloadSample);
this.menuToggle = argValueToBoolean(raw.menuToggle, true);
this.jsonSampleExpandLevel = RedocNormalizedOptions.normalizeJsonSampleExpandLevel(
raw.jsonSampleExpandLevel,

5
src/services/models/Operation.ts
View File

@ -195,6 +195,7 @@ export class OperationModel implements IMenuItem {
@memoize
get codeSamples() {
const { payloadSampleIdx, hideRequestPayloadSample } = this.options;
let samples: Array<OpenAPIXCodeSample | XPayloadSample> =
this.operationSpec['x-codeSamples'] || this.operationSpec['x-code-samples'] || [];
@ -204,8 +205,8 @@ export class OperationModel implements IMenuItem {
}
const requestBodyContent = this.requestBody && this.requestBody.content;
if (requestBodyContent && requestBodyContent.hasSample) {
const insertInx = Math.min(samples.length, this.options.payloadSampleIdx);
if (requestBodyContent && requestBodyContent.hasSample && !hideRequestPayloadSample) {
const insertInx = Math.min(samples.length, payloadSampleIdx);
samples = [
...samples.slice(0, insertInx),