alihan/fastapi-openapi-to-postman
1
0
Fork 0
mirror of https://github.com/postmanlabs/openapi-to-postman.git synced 2022-11-29 22:05:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added support for stackLimit option to customize schema resolution level

Browse Source
This commit is contained in:
Vishal Shingala
2021-08-17 17:11:00 +05:30
parent 8f7a6be09d
commit 1716c4cdc3
3 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/deref.js
View File

@@ -218,7 +218,7 @@ module.exports = {
this._currentRefStack.push(refKey); this._currentRefStack.push(refKey);
let refResolvedSchema = this.resolveRefs(resolvedSchema, parameterSourceOption, let refResolvedSchema = this.resolveRefs(resolvedSchema, parameterSourceOption,
components, schemaResolutionCache, resolveFor, resolveTo, stack, _.cloneDeep(seenRef)); components, schemaResolutionCache, resolveFor, resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
// remove current ref that's being resolved from stack as soon as resolved // remove current ref that's being resolved from stack as soon as resolved
_.isArray(this._currentRefStack) && (this._currentRefStack.pop()); _.isArray(this._currentRefStack) && (this._currentRefStack.pop());
@@ -258,7 +258,7 @@ module.exports = {
} }
/* eslint-enable */ /* eslint-enable */
tempSchema.properties[prop] = this.resolveRefs(property, parameterSourceOption, components, tempSchema.properties[prop] = this.resolveRefs(property, parameterSourceOption, components,
schemaResolutionCache, resolveFor, resolveTo, stack, _.cloneDeep(seenRef)); schemaResolutionCache, resolveFor, resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
} }
} }
return tempSchema; return tempSchema;
@@ -296,7 +296,7 @@ module.exports = {
// without this, schemas with circular references aren't faked correctly // without this, schemas with circular references aren't faked correctly
let tempSchema = _.omit(schema, 'items'); let tempSchema = _.omit(schema, 'items');
tempSchema.items = this.resolveRefs(schema.items, parameterSourceOption, tempSchema.items = this.resolveRefs(schema.items, parameterSourceOption,
components, schemaResolutionCache, resolveFor, resolveTo, stack, _.cloneDeep(seenRef)); components, schemaResolutionCache, resolveFor, resolveTo, stack, _.cloneDeep(seenRef), stackLimit);
return tempSchema; return tempSchema;
} }
else if (!schema.hasOwnProperty('default')) { else if (!schema.hasOwnProperty('default')) {

13
lib/options.js
View File

@@ -116,6 +116,15 @@ module.exports = {
external: false, external: false,
usage: ['CONVERSION'] usage: ['CONVERSION']
}, },
{
name: 'Schema resolution nesting limit',
id: 'stackLimit',
type: 'integer',
default: 10,
description: 'Number of nesting limit till which schema resolution will happen.',
external: false,
usage: ['CONVERSION']
},
{ {
name: 'Include auth info in example requests', name: 'Include auth info in example requests',
id: 'includeAuthInfoInExample', id: 'includeAuthInfoInExample',
@@ -246,8 +255,8 @@ module.exports = {
// options to be used as documentation // options to be used as documentation
return _.filter(optsArray, (opt) => { return _.filter(optsArray, (opt) => {
// only return options that are externally controllable // only return options that are not disabled
return opt.external === true; return opt.disabled !== true;
}); });
} }
}; };

9
lib/utils.js
View File

@@ -66,6 +66,15 @@ module.exports = {
} }
break; break;
case 'integer':
if (_.isSafeInteger(userOptions[id])) {
retVal[id] = userOptions[id];
}
else {
retVal[id] = defaultOptions[id].default;
}
break;
default: default:
retVal[id] = defaultOptions[id].default; retVal[id] = defaultOptions[id].default;
} }