diff --git a/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap b/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap index 27cb32d2..75ff2879 100644 --- a/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap +++ b/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap @@ -84,7 +84,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -104,6 +104,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -358,7 +359,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -378,6 +379,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -619,7 +621,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -639,6 +641,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -942,7 +945,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -962,6 +965,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -1228,7 +1232,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -1248,6 +1252,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -1485,7 +1490,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -1505,6 +1510,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -1767,7 +1773,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -1787,6 +1793,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -2079,7 +2086,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -2099,6 +2106,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -2353,7 +2361,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -2373,6 +2381,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, @@ -2614,7 +2623,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "expandDefaultServerVariables": false, "expandResponses": {}, "expandSingleSchemaField": false, - "generatedPayloadSamplesMaxDepth": 10, + "generatedSamplesMaxDepth": 10, "hideDownloadButtons": false, "hideFab": false, "hideHostname": false, @@ -2634,6 +2643,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView "pathInMiddlePanel": false, "payloadSampleIdx": 0, "sanitize": false, + "schemaDefinitionsTagName": undefined, "schemasExpansionLevel": 0, "scrollYOffset": [Function], "showExtensions": false, diff --git a/src/services/RedocNormalizedOptions.ts b/src/services/RedocNormalizedOptions.ts index 951871c7..35b906a9 100644 --- a/src/services/RedocNormalizedOptions.ts +++ b/src/services/RedocNormalizedOptions.ts @@ -64,7 +64,8 @@ export interface RedocRawOptions { maxDisplayedEnumValues?: number; ignoreNamedSchemas?: string[] | string; hideSchemaPattern?: boolean; - generatedPayloadSamplesMaxDepth?: number; + generatedPayloadSamplesMaxDepth?: number; // remove in next major release + generatedSamplesMaxDepth?: number; nonce?: string; hideFab?: boolean; minCharacterLengthToInitSearch?: number; @@ -268,7 +269,7 @@ export class RedocNormalizedOptions { ignoreNamedSchemas: Set; hideSchemaPattern: boolean; - generatedPayloadSamplesMaxDepth: number; + generatedSamplesMaxDepth: number; hideFab: boolean; minCharacterLengthToInitSearch: number; showWebhookVerb: boolean; @@ -350,10 +351,9 @@ export class RedocNormalizedOptions { : raw.ignoreNamedSchemas?.split(',').map(s => s.trim()); this.ignoreNamedSchemas = new Set(ignoreNamedSchemas); this.hideSchemaPattern = argValueToBoolean(raw.hideSchemaPattern); - this.generatedPayloadSamplesMaxDepth = - RedocNormalizedOptions.normalizeGeneratedPayloadSamplesMaxDepth( - raw.generatedPayloadSamplesMaxDepth, - ); + this.generatedSamplesMaxDepth = RedocNormalizedOptions.normalizeGeneratedPayloadSamplesMaxDepth( + raw.generatedSamplesMaxDepth || raw.generatedPayloadSamplesMaxDepth, + ); this.nonce = raw.nonce; this.hideFab = argValueToBoolean(raw.hideFab); this.minCharacterLengthToInitSearch = argValueToNumber(raw.minCharacterLengthToInitSearch) || 3; diff --git a/src/services/models/MediaType.ts b/src/services/models/MediaType.ts index 1b7263ae..de80042a 100644 --- a/src/services/models/MediaType.ts +++ b/src/services/models/MediaType.ts @@ -14,7 +14,7 @@ export class MediaTypeModel { name: string; isRequestType: boolean; onlyRequiredInSamples: boolean; - generatedPayloadSamplesMaxDepth: number; + generatedSamplesMaxDepth: number; /** * @param isRequestType needed to know if skipe RO/RW fields in objects @@ -30,7 +30,7 @@ export class MediaTypeModel { this.isRequestType = isRequestType; this.schema = info.schema && new SchemaModel(parser, info.schema, '', options); this.onlyRequiredInSamples = options.onlyRequiredInSamples; - this.generatedPayloadSamplesMaxDepth = options.generatedPayloadSamplesMaxDepth; + this.generatedSamplesMaxDepth = options.generatedSamplesMaxDepth; if (info.examples !== undefined) { this.examples = mapValues( info.examples, @@ -55,7 +55,7 @@ export class MediaTypeModel { skipReadOnly: this.isRequestType, skipWriteOnly: !this.isRequestType, skipNonRequired: this.isRequestType && this.onlyRequiredInSamples, - maxSampleDepth: this.generatedPayloadSamplesMaxDepth, + maxSampleDepth: this.generatedSamplesMaxDepth, }; if (this.schema && this.schema.oneOf) { this.examples = {};