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

Fixed issue where description was missing from suggested fix for missing_in_request type of mismatches

Browse Source
This commit is contained in:
Vishal Shingala
2021-07-22 17:05:41 +05:30
parent bb35217f3f
commit 4c57b5e75a
5 changed files with 41 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
lib/schemaUtils.js
View File

@@ -382,6 +382,9 @@ module.exports = {
* @returns {string} description of the parameters * @returns {string} description of the parameters
*/ */
getParameterDescription: function(parameter) { getParameterDescription: function(parameter) {
if (!_.isObject(parameter)) {
return '';
}
return (parameter.required ? '(Required) ' : '') + (parameter.description || '') + return (parameter.required ? '(Required) ' : '') + (parameter.description || '') +
(parameter.enum ? ' (This can only be one of ' + parameter.enum + ')' : ''); (parameter.enum ? ' (This can only be one of ' + parameter.enum + ')' : '');
}, },
@@ -2853,11 +2856,13 @@ module.exports = {
} }
else { else {
let required = _.get(metaInfo, 'required') || false, let required = _.get(metaInfo, 'required') || false,
description = _.get(metaInfo, 'description') || '',
pathPrefix = _.get(metaInfo, 'pathPrefix'); pathPrefix = _.get(metaInfo, 'pathPrefix');
childParamSchemas.push({ childParamSchemas.push({
name: `${paramKey}[${key}]`, name: `${paramKey}[${key}]`,
schema: value, schema: value,
description,
required, required,
isResolvedParam: true, isResolvedParam: true,
pathPrefix pathPrefix
@@ -3263,7 +3268,8 @@ module.exports = {
key: pathVar.name, key: pathVar.name,
value: safeSchemaFaker(pathVar.schema || {}, 'example', PROCESSING_TYPE.VALIDATION, value: safeSchemaFaker(pathVar.schema || {}, 'example', PROCESSING_TYPE.VALIDATION,
PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache, PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache,
options.stackLimit) options.stackLimit),
description: this.getParameterDescription(pathVar)
} }
}; };
} }
@@ -3453,7 +3459,7 @@ module.exports = {
// resolve all child params of parent param with deepObject style // resolve all child params of parent param with deepObject style
if (style === 'deepObject') { if (style === 'deepObject') {
resolvedSchemaParams = _.concat(resolvedSchemaParams, this.extractChildParamSchema(paramSchema, resolvedSchemaParams = _.concat(resolvedSchemaParams, this.extractChildParamSchema(paramSchema,
param.name, { required: _.get(param, 'required'), pathPrefix })); param.name, { required: _.get(param, 'required'), pathPrefix, description: _.get(param, 'description') }));
} }
else { else {
// add schema of all properties instead entire object // add schema of all properties instead entire object
@@ -3462,6 +3468,7 @@ module.exports = {
name: propName, name: propName,
schema: propSchema, schema: propSchema,
required: _.get(param, 'required') || false, required: _.get(param, 'required') || false,
description: _.get(param, 'description'),
isResolvedParam: true, isResolvedParam: true,
pathPrefix pathPrefix
}); });
@@ -3547,7 +3554,8 @@ module.exports = {
key: qp.name, key: qp.name,
value: safeSchemaFaker(qp.schema || {}, 'example', PROCESSING_TYPE.VALIDATION, value: safeSchemaFaker(qp.schema || {}, 'example', PROCESSING_TYPE.VALIDATION,
PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache, PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache,
options.stackLimit) options.stackLimit),
description: this.getParameterDescription(qp)
} }
}; };
} }
@@ -3774,7 +3782,8 @@ module.exports = {
key: header.name, key: header.name,
value: safeSchemaFaker(header.schema || {}, 'example', PROCESSING_TYPE.VALIDATION, value: safeSchemaFaker(header.schema || {}, 'example', PROCESSING_TYPE.VALIDATION,
PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache, PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache,
options.stackLimit) options.stackLimit),
description: this.getParameterDescription(header)
} }
}; };
} }
@@ -3881,7 +3890,8 @@ module.exports = {
key: header.name, key: header.name,
value: safeSchemaFaker(header.schema || {}, 'example', PROCESSING_TYPE.VALIDATION, value: safeSchemaFaker(header.schema || {}, 'example', PROCESSING_TYPE.VALIDATION,
PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache, PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache,
options.stackLimit) options.stackLimit),
description: this.getParameterDescription(header)
} }
}; };
} }
@@ -3942,7 +3952,8 @@ module.exports = {
let resolvedProp = { let resolvedProp = {
name: propName, name: propName,
schema: propSchema, schema: propSchema,
in: 'query' // serialization follows same behaviour as query params in: 'query', // serialization follows same behaviour as query params
description: _.get(propSchema, 'description') || ''
}, },
encodingValue = _.get(schemaPath, ['requestBody', 'content', URLENCODED, 'encoding', propName]), encodingValue = _.get(schemaPath, ['requestBody', 'content', URLENCODED, 'encoding', propName]),
pSerialisationInfo, pSerialisationInfo,
@@ -3978,7 +3989,7 @@ module.exports = {
// resolve all child params of parent param with deepObject style // resolve all child params of parent param with deepObject style
if (pSerialisationInfo.style === 'deepObject') { if (pSerialisationInfo.style === 'deepObject') {
resolvedSchemaParams = _.concat(resolvedSchemaParams, this.extractChildParamSchema(propSchema, resolvedSchemaParams = _.concat(resolvedSchemaParams, this.extractChildParamSchema(propSchema,
propName, { required: resolvedProp.required || false })); propName, { required: resolvedProp.required || false, description: resolvedProp.description }));
} }
else { else {
// add schema of all properties instead entire object // add schema of all properties instead entire object
@@ -3987,7 +3998,8 @@ module.exports = {
name: key, name: key,
schema: value, schema: value,
isResolvedParam: true, isResolvedParam: true,
required: resolvedProp.required || false required: resolvedProp.required || false,
description: resolvedProp.description
}); });
}); });
} }
@@ -4090,7 +4102,8 @@ module.exports = {
key: uParam.name, key: uParam.name,
value: safeSchemaFaker(uParam.schema || {}, 'example', PROCESSING_TYPE.VALIDATION, value: safeSchemaFaker(uParam.schema || {}, 'example', PROCESSING_TYPE.VALIDATION,
PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache, PARAMETER_SOURCE.REQUEST, components, SCHEMA_FORMATS.DEFAULT, options.indentCharacter, schemaCache,
options.stackLimit) options.stackLimit),
description: this.getParameterDescription(uParam)
} }
}; };
} }

5
test/data/validationData/suggestAvailableFixesCollection.json
View File

@@ -39,11 +39,6 @@
] ]
}, },
"header": [ "header": [
{
"description": "(Required) ",
"key": "pet-quantity",
"value": "Not a Boolean"
},
{ {
"key": "Content-Type", "key": "Content-Type",
"value": "application/json" "value": "application/json"

1
test/data/validationData/suggestAvailableFixesSpec.yaml
View File

@@ -29,6 +29,7 @@ paths:
example: 'Not a Number' example: 'Not a Number'
- name: pet-quantity - name: pet-quantity
in: header in: header
description: Quantity of pets available
required: true required: true
schema: schema:
type: boolean type: boolean

6
test/data/validationData/urlencodedBodySpec.yaml
View File

@@ -81,8 +81,12 @@ paths:
type: integer type: integer
prop2ArrayComp: prop2ArrayComp:
type: string type: string
propMissingInReq:
type: integer
description: This property is not available in matched collection.
example: 321
required: required:
- status - propMissingInReq
encoding: encoding:
propObjectExplodable: propObjectExplodable:
style: form style: form

16
test/unit/validator.test.js
View File

@@ -300,7 +300,9 @@ describe('The Validation option', function () {
// check for all suggested value to be according to schema // check for all suggested value to be according to schema
expect(_.isInteger(propertyMismatchMap.PATHVARIABLE.suggestedFix.suggestedValue)).to.eql(true); expect(_.isInteger(propertyMismatchMap.PATHVARIABLE.suggestedFix.suggestedValue)).to.eql(true);
expect(propertyMismatchMap.QUERYPARAM.suggestedFix.suggestedValue).to.be.a('number'); expect(propertyMismatchMap.QUERYPARAM.suggestedFix.suggestedValue).to.be.a('number');
expect(propertyMismatchMap.HEADER.suggestedFix.suggestedValue).to.be.a('boolean'); expect(propertyMismatchMap.HEADER.suggestedFix.suggestedValue.value).to.be.a('boolean');
expect(propertyMismatchMap.HEADER.suggestedFix.suggestedValue.description)
.to.eql('(Required) Quantity of pets available');
expect(propertyMismatchMap.BODY.suggestedFix.suggestedValue.name).to.be.a('string'); expect(propertyMismatchMap.BODY.suggestedFix.suggestedValue.name).to.be.a('string');
expect(propertyMismatchMap.BODY.suggestedFix.suggestedValue.name.length >= 30).to.eql(true); expect(propertyMismatchMap.BODY.suggestedFix.suggestedValue.name.length >= 30).to.eql(true);
expect(propertyMismatchMap.BODY.suggestedFix.suggestedValue.tag).to.be.a('string'); expect(propertyMismatchMap.BODY.suggestedFix.suggestedValue.tag).to.be.a('string');
@@ -680,7 +682,8 @@ describe('VALIDATE FUNCTION TESTS ', function () {
expect(resultObj.mismatches[1].suggestedFix.actualValue).to.be.null; expect(resultObj.mismatches[1].suggestedFix.actualValue).to.be.null;
expect(resultObj.mismatches[1].suggestedFix.suggestedValue).to.eql({ expect(resultObj.mismatches[1].suggestedFix.suggestedValue).to.eql({
key: 'user[address][country]', key: 'user[address][country]',
value: 'India' value: 'India',
description: '(Required) info about user'
}); });
done(); done();
}); });
@@ -721,7 +724,7 @@ describe('VALIDATE FUNCTION TESTS ', function () {
expect(err).to.be.null; expect(err).to.be.null;
expect(result).to.be.an('object'); expect(result).to.be.an('object');
resultObj = result.requests[historyRequest[0].id].endpoints[0]; resultObj = result.requests[historyRequest[0].id].endpoints[0];
expect(resultObj.mismatches).to.have.lengthOf(4); expect(resultObj.mismatches).to.have.lengthOf(5);
/** /**
* no mismatches should be found for complex array type params as validation is skipped for them, * no mismatches should be found for complex array type params as validation is skipped for them,
@@ -751,6 +754,13 @@ describe('VALIDATE FUNCTION TESTS ', function () {
expect(resultObj.mismatches[3].transactionJsonPath).to.eql('$.request.body.urlencoded[8].value'); expect(resultObj.mismatches[3].transactionJsonPath).to.eql('$.request.body.urlencoded[8].value');
expect(resultObj.mismatches[3].suggestedFix.actualValue).to.eql('123'); expect(resultObj.mismatches[3].suggestedFix.actualValue).to.eql('123');
expect(resultObj.mismatches[3].suggestedFix.suggestedValue).to.eql('Delhi'); expect(resultObj.mismatches[3].suggestedFix.suggestedValue).to.eql('Delhi');
// property named "propMissingInReq" is missing in request
expect(resultObj.mismatches[4].reasonCode).to.eql('MISSING_IN_REQUEST');
expect(resultObj.mismatches[4].suggestedFix.actualValue).to.eql(null);
expect(resultObj.mismatches[4].suggestedFix.suggestedValue.key).to.eql('propMissingInReq');
expect(resultObj.mismatches[4].suggestedFix.suggestedValue.description)
.to.eql('(Required) This property is not available in matched collection.');
done(); done();
}); });
}); });