MCPcopy
hub / github.com/Surnet/swagger-jsdoc / clean

Function clean

src/specification.js:86–99  ·  view source on GitHub ↗

* OpenAPI specification validator does not accept empty values for a few properties. * Solves validator error: "Schema error should NOT have additional properties" * @param {object} swaggerObject * @returns {object} swaggerObject

(swaggerObject)

Source from the content-addressed store, hash-verified

84 * @returns {object} swaggerObject
85 */
86function clean(swaggerObject) {
87 for (const prop of [
88 'definitions',
89 'responses',
90 'parameters',
91 'securityDefinitions',
92 ]) {
93 if (hasEmptyProperty(swaggerObject[prop])) {
94 delete swaggerObject[prop];
95 }
96 }
97
98 return swaggerObject;
99}
100
101/**
102 * Parse the swagger object and remove useless properties if necessary.

Callers 1

finalizeFunction · 0.85

Calls 1

hasEmptyPropertyFunction · 0.85

Tested by

no test coverage detected