Add onlyRequiredInSamples option that let user to show only required …

…fields in Request samples.
Redocly · Sep 16, 2018 · 7fb1e90 · 7fb1e90
1 parent ab98ab0
commit 7fb1e90
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -221,6 +221,7 @@ You can use all of the following options with standalone version on <redoc> tag
 * `nativeScrollbars` - use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs)
 * `hideDownloadButton` - do not show "Download" spec button. **THIS DOESN'T MAKE YOUR SPEC PRIVATE**, it just hides the button.
 * `disableSearch` - disable search indexing and search box
+* `onlyRequiredInSamples` - shows only required fields in request samples.
 * `theme` - ReDoc theme. Not documented yet. For details check source code: [theme.ts](https://github.com/Rebilly/ReDoc/blob/master/src/theme.ts)
 
 ## Advanced usage of standalone version
@@ -242,4 +243,4 @@ Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
 
 -----------
 ## Development
-see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
+see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
diff --git a/src/services/RedocNormalizedOptions.ts b/src/services/RedocNormalizedOptions.ts
@@ -17,6 +17,7 @@ export interface RedocRawOptions {
   hideLoading?: boolean | string;
   hideDownloadButton?: boolean | string;
   disableSearch?: boolean | string;
+  onlyRequiredInSamples?: boolean | string;
 
   unstable_ignoreMimeParameters?: boolean;
 
@@ -99,6 +100,7 @@ export class RedocNormalizedOptions {
   untrustedSpec: boolean;
   hideDownloadButton: boolean;
   disableSearch: boolean;
+  onlyRequiredInSamples: boolean;
 
   /* tslint:disable-next-line */
   unstable_ignoreMimeParameters: boolean;
@@ -124,6 +126,7 @@ export class RedocNormalizedOptions {
     this.untrustedSpec = argValueToBoolean(raw.untrustedSpec);
     this.hideDownloadButton = argValueToBoolean(raw.hideDownloadButton);
     this.disableSearch = argValueToBoolean(raw.disableSearch);
+    this.onlyRequiredInSamples = argValueToBoolean(raw.onlyRequiredInSamples);
 
     this.unstable_ignoreMimeParameters = argValueToBoolean(raw.unstable_ignoreMimeParameters);
 

diff --git a/src/services/models/MediaType.ts b/src/services/models/MediaType.ts
@@ -13,6 +13,7 @@ export class MediaTypeModel {
   schema?: SchemaModel;
   name: string;
   isRequestType: boolean;
+  onlyRequiredInSamples: boolean;
 
   /**
    * @param isRequestType needed to know if skipe RO/RW fields in objects
@@ -27,6 +28,7 @@ export class MediaTypeModel {
     this.name = name;
     this.isRequestType = isRequestType;
     this.schema = info.schema && new SchemaModel(parser, info.schema, '', options);
+    this.onlyRequiredInSamples = options.onlyRequiredInSamples;
     if (info.examples !== undefined) {
       this.examples = mapValues(info.examples, example => new ExampleModel(parser, example));
     } else if (info.example !== undefined) {
@@ -39,12 +41,17 @@ export class MediaTypeModel {
   }
 
   generateExample(parser: OpenAPIParser, info: OpenAPIMediaType) {
+    const samplerOption = {
+      skipReadOnly: this.isRequestType,
+      skipNonRequired: this.isRequestType && this.onlyRequiredInSamples,
+      skipWriteOnly: !this.isRequestType
+    };
     if (this.schema && this.schema.oneOf) {
       this.examples = {};
       for (const subSchema of this.schema.oneOf) {
         const sample = Sampler.sample(
           subSchema.rawSchema,
-          { skipReadOnly: this.isRequestType, skipWriteOnly: !this.isRequestType },
+          samplerOption,
           parser.spec,
         );
 
@@ -61,7 +68,7 @@ export class MediaTypeModel {
         default: new ExampleModel(parser, {
           value: Sampler.sample(
             info.schema,
-            { skipReadOnly: this.isRequestType, skipWriteOnly: !this.isRequestType },
+            samplerOption,
             parser.spec,
           ),
         }),