docs-util: improvements and fixes to OAS generation (#8855)

- Add to knowledge base summaries for delete-related properties
- Fix long curl examples overflowing the line
- Fix singular / plural usage in some knowledge base descriptions / summaries
- Fix some workflows not picked up
- Remove query params for routes that don't use them.
This commit is contained in:
Shahed Nasser
2024-08-29 11:40:55 +03:00
committed by GitHub
parent 16d8fb1d20
commit 25134d2307
3 changed files with 93 additions and 59 deletions

View File

@@ -13,8 +13,7 @@ export default function formatOas(
oas: OpenApiOperation | OpenApiSchema,
oasPrefix: string
) {
return `* ${oasPrefix}${DOCBLOCK_NEW_LINE}${stringify(oas).replaceAll(
"\n",
DOCBLOCK_NEW_LINE
)}${DOCBLOCK_END_LINE}`
return `* ${oasPrefix}${DOCBLOCK_NEW_LINE}${stringify(oas, {
lineWidth: 200,
}).replaceAll("\n", DOCBLOCK_NEW_LINE)}${DOCBLOCK_END_LINE}`
}