fix: hideRequestPayloadSample (Redocly#2436)

Bandwidth · Nov 1, 2023 · 8c65136 · 8c65136
1 parent fec880b
commit 8c65136
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap b/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap
@@ -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,
@@ -376,6 +377,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                     "hideDownloadButton": false,
                     "hideFab": false,
                     "hideHostname": false,
+                    "hideRequestPayloadSample": false,
                     "hideSchemaPattern": false,
                     "hideSchemaTitles": false,
                     "hideSecuritySection": false,
@@ -652,6 +654,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "hideDownloadButton": false,
               "hideFab": false,
               "hideHostname": false,
+              "hideRequestPayloadSample": false,
               "hideSchemaPattern": false,
               "hideSchemaTitles": false,
               "hideSecuritySection": false,
@@ -990,6 +993,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                     "hideDownloadButton": false,
                     "hideFab": false,
                     "hideHostname": false,
+                    "hideRequestPayloadSample": false,
                     "hideSchemaPattern": false,
                     "hideSchemaTitles": false,
                     "hideSecuritySection": false,
@@ -1291,6 +1295,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                     "hideDownloadButton": false,
                     "hideFab": false,
                     "hideHostname": false,
+                    "hideRequestPayloadSample": false,
                     "hideSchemaPattern": false,
                     "hideSchemaTitles": false,
                     "hideSecuritySection": false,
@@ -1563,6 +1568,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "hideDownloadButton": false,
               "hideFab": false,
               "hideHostname": false,
+              "hideRequestPayloadSample": false,
               "hideSchemaPattern": false,
               "hideSchemaTitles": false,
               "hideSecuritySection": false,
@@ -1860,6 +1866,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
           "hideDownloadButton": false,
           "hideFab": false,
           "hideHostname": false,
+          "hideRequestPayloadSample": false,
           "hideSchemaPattern": false,
           "hideSchemaTitles": false,
           "hideSecuritySection": false,
@@ -2187,6 +2194,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "hideDownloadButton": false,
               "hideFab": false,
               "hideHostname": false,
+              "hideRequestPayloadSample": false,
               "hideSchemaPattern": false,
               "hideSchemaTitles": false,
               "hideSecuritySection": false,
@@ -2476,6 +2484,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "hideDownloadButton": false,
               "hideFab": false,
               "hideHostname": false,
+              "hideRequestPayloadSample": false,
               "hideSchemaPattern": false,
               "hideSchemaTitles": false,
               "hideSecuritySection": false,
@@ -2752,6 +2761,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
         "hideDownloadButton": false,
         "hideFab": false,
         "hideHostname": false,
+        "hideRequestPayloadSample": false,
         "hideSchemaPattern": false,
         "hideSchemaTitles": false,
         "hideSecuritySection": false,

diff --git a/src/services/RedocNormalizedOptions.ts b/src/services/RedocNormalizedOptions.ts
@@ -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,

diff --git a/src/services/models/Operation.ts b/src/services/models/Operation.ts
@@ -202,6 +202,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'] || [];
 
@@ -211,8 +212,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),