Fix requestBody description requirement in completeness analyzer #36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…lyzer The requestBody.description field is optional per OpenAPI spec. Removed '$.paths.*.*.requestBody' from description-for-every-attribute rule in completeness.js. Added tests to verify the fix.
esyriac
approved these changes
Jan 8, 2026
esyriac
left a comment
esyriac
left a comment
There was a problem hiding this comment.
Please make sure that removing requestBody from the criteria is not breaking any other required functionality. please do a thorough testing...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The description-for-every-attribute rule in the completeness analyzer was incorrectly requiring a description field on requestBody objects. According to the OpenAPI Specification, requestBody.description is optional:
Solution
Removed '$.paths...requestBody' from the given array in the description-for-every-attribute rule in completeness.js.
Testing
Added new test suite test/completeness-description-for-every-attribute.spec.js with 4 test cases:
All 138 test suites pass (552 tests total).