fix(api): Check all nodes for a description field (#4458)

- Replace named nodes in decorator with the any key.
- If the node description field is a string, replace URLs.
pull/4461/head
Jason Stirnaman 2022-09-15 11:44:08 -05:00 committed by GitHub
parent c912f3bcb2
commit 260ed64b3b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 70 deletions

View File

@ -14,78 +14,13 @@ function replaceDocsUrl(field) {
/** @type {import('@redocly/openapi-cli').OasDecorator} */
function docsUrl() {
return {
DefinitionRoot: {
Example: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
},
},
ExternalDocs: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
},
},
Header: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
},
},
Info: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
},
},
Operation: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
},
},
Parameter: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
any: {
leave(node, ctx) {
if(node.description && typeof(node.description) === 'string') {
node.description = replaceDocsUrl(node.description);
}
},
PathItem: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
},
RequestBody: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
},
Response: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
},
Schema: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
},
SecurityScheme: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
},
Server: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
},
Tag: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
},
XCodeSample: {
leave(node, ctx) {
node.description = replaceDocsUrl(node.description);
}
}
}
},
}
}