Skip to content

Commit ea34064

Browse files
committed
Avoid showing assorted pointless OpenAPI response descriptions
1 parent 4f649c4 commit ea34064

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/model/api/openapi.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -449,9 +449,11 @@ class OpenApiResponse implements ApiResponse {
449449
)
450450
: undefined;
451451

452-
this.description = bodySpec && bodySpec.description !== response.statusMessage
453-
? fromMarkdown(bodySpec.description, { linkify: true })
454-
: undefined;
452+
this.description = bodySpec?.description &&
453+
bodySpec.description !== response.statusMessage && // Ignore description "Not Found" and similar
454+
bodySpec.description.split(' ').filter(Boolean).length! > 2 // Ignore pointlessly short (Response/Error Response) descriptions
455+
? fromMarkdown(bodySpec.description, { linkify: true })
456+
: undefined;
455457
this.bodySchema = getBodySchema(spec, bodySpec, response);
456458
}
457459

0 commit comments

Comments
 (0)