Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-07-11 00:32:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: add support generatedSamplesMaxDepth instead of generatedPayloadSamplesMaxDepth

Browse Source
This commit is contained in:
Alex Varchuk 2025-01-17 16:27:01 +01:00
parent bf97710c59
commit 349a194879
No known key found for this signature in database
GPG Key ID: 8A9260AE529FF454
3 changed files with 29 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -84,7 +84,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -104,6 +104,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -358,7 +359,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -378,6 +379,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -619,7 +621,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -639,6 +641,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -942,7 +945,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -962,6 +965,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -1228,7 +1232,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -1248,6 +1252,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -1485,7 +1490,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -1505,6 +1510,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -1767,7 +1773,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -1787,6 +1793,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -2079,7 +2086,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -2099,6 +2106,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -2353,7 +2361,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -2373,6 +2381,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,
@ -2614,7 +2623,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"expandDefaultServerVariables": false, "expandDefaultServerVariables": false,
"expandResponses": {}, "expandResponses": {},
"expandSingleSchemaField": false, "expandSingleSchemaField": false,
"generatedPayloadSamplesMaxDepth": 10, "generatedSamplesMaxDepth": 10,
"hideDownloadButtons": false, "hideDownloadButtons": false,
"hideFab": false, "hideFab": false,
"hideHostname": false, "hideHostname": false,
@ -2634,6 +2643,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
"pathInMiddlePanel": false, "pathInMiddlePanel": false,
"payloadSampleIdx": 0, "payloadSampleIdx": 0,
"sanitize": false, "sanitize": false,
"schemaDefinitionsTagName": undefined,
"schemasExpansionLevel": 0, "schemasExpansionLevel": 0,
"scrollYOffset": [Function], "scrollYOffset": [Function],
"showExtensions": false, "showExtensions": false,

12
src/services/RedocNormalizedOptions.ts
View File

@ -64,7 +64,8 @@ export interface RedocRawOptions {
maxDisplayedEnumValues?: number; maxDisplayedEnumValues?: number;
ignoreNamedSchemas?: string[] | string; ignoreNamedSchemas?: string[] | string;
hideSchemaPattern?: boolean; hideSchemaPattern?: boolean;
generatedPayloadSamplesMaxDepth?: number; generatedPayloadSamplesMaxDepth?: number; // remove in next major release
generatedSamplesMaxDepth?: number;
nonce?: string; nonce?: string;
hideFab?: boolean; hideFab?: boolean;
minCharacterLengthToInitSearch?: number; minCharacterLengthToInitSearch?: number;
@ -268,7 +269,7 @@ export class RedocNormalizedOptions {
ignoreNamedSchemas: Set<string>; ignoreNamedSchemas: Set<string>;
hideSchemaPattern: boolean; hideSchemaPattern: boolean;
generatedPayloadSamplesMaxDepth: number; generatedSamplesMaxDepth: number;
hideFab: boolean; hideFab: boolean;
minCharacterLengthToInitSearch: number; minCharacterLengthToInitSearch: number;
showWebhookVerb: boolean; showWebhookVerb: boolean;
@ -350,10 +351,9 @@ export class RedocNormalizedOptions {
: raw.ignoreNamedSchemas?.split(',').map(s => s.trim()); : raw.ignoreNamedSchemas?.split(',').map(s => s.trim());
this.ignoreNamedSchemas = new Set(ignoreNamedSchemas); this.ignoreNamedSchemas = new Set(ignoreNamedSchemas);
this.hideSchemaPattern = argValueToBoolean(raw.hideSchemaPattern); this.hideSchemaPattern = argValueToBoolean(raw.hideSchemaPattern);
this.generatedPayloadSamplesMaxDepth = this.generatedSamplesMaxDepth = RedocNormalizedOptions.normalizeGeneratedPayloadSamplesMaxDepth(
RedocNormalizedOptions.normalizeGeneratedPayloadSamplesMaxDepth( raw.generatedSamplesMaxDepth || raw.generatedPayloadSamplesMaxDepth,
raw.generatedPayloadSamplesMaxDepth, );
);
this.nonce = raw.nonce; this.nonce = raw.nonce;
this.hideFab = argValueToBoolean(raw.hideFab); this.hideFab = argValueToBoolean(raw.hideFab);
this.minCharacterLengthToInitSearch = argValueToNumber(raw.minCharacterLengthToInitSearch) || 3; this.minCharacterLengthToInitSearch = argValueToNumber(raw.minCharacterLengthToInitSearch) || 3;

6
src/services/models/MediaType.ts
View File

@ -14,7 +14,7 @@ export class MediaTypeModel {
name: string; name: string;
isRequestType: boolean; isRequestType: boolean;
onlyRequiredInSamples: boolean; onlyRequiredInSamples: boolean;
generatedPayloadSamplesMaxDepth: number; generatedSamplesMaxDepth: number;
/** /**
* @param isRequestType needed to know if skipe RO/RW fields in objects * @param isRequestType needed to know if skipe RO/RW fields in objects
@ -30,7 +30,7 @@ export class MediaTypeModel {
this.isRequestType = isRequestType; this.isRequestType = isRequestType;
this.schema = info.schema && new SchemaModel(parser, info.schema, '', options); this.schema = info.schema && new SchemaModel(parser, info.schema, '', options);
this.onlyRequiredInSamples = options.onlyRequiredInSamples; this.onlyRequiredInSamples = options.onlyRequiredInSamples;
this.generatedPayloadSamplesMaxDepth = options.generatedPayloadSamplesMaxDepth; this.generatedSamplesMaxDepth = options.generatedSamplesMaxDepth;
if (info.examples !== undefined) { if (info.examples !== undefined) {
this.examples = mapValues( this.examples = mapValues(
info.examples, info.examples,
@ -55,7 +55,7 @@ export class MediaTypeModel {
skipReadOnly: this.isRequestType, skipReadOnly: this.isRequestType,
skipWriteOnly: !this.isRequestType, skipWriteOnly: !this.isRequestType,
skipNonRequired: this.isRequestType && this.onlyRequiredInSamples, skipNonRequired: this.isRequestType && this.onlyRequiredInSamples,
maxSampleDepth: this.generatedPayloadSamplesMaxDepth, maxSampleDepth: this.generatedSamplesMaxDepth,
}; };
if (this.schema && this.schema.oneOf) { if (this.schema && this.schema.oneOf) {
this.examples = {}; this.examples = {};