Skip to content

fix(ipa): handle delete request bodies in IPA-117 #1339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
andmatei wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(ipa): handle delete request bodies in IPA-117 #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions tools/spectral/ipa/__tests__/IPA117RequestResponseBodiesMustBeWellDefined.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,65 @@ testRule('xgen-IPA-117-request-response-bodies-must-be-well-defined', [
},
errors: [],
},
{
name: 'delete request body with schema does not crash',
document: {
paths: {
'/resource/{id}': {
delete: {
requestBody: {
content: {
'application/vnd.atlas.2024-08-05+json': {
schema: {
type: 'object',
},
},
},
},
responses: {
204: {
content: {
'application/vnd.atlas.2024-08-05+json': {},
},
},
},
},
},
},
},
errors: [],
},
{
name: 'delete request body without schema is still validated',
document: {
paths: {
'/resource/{id}': {
delete: {
requestBody: {
content: {
'application/vnd.atlas.2024-08-05+json': {},
},
},
responses: {
204: {
content: {
'application/vnd.atlas.2024-08-05+json': {},
},
},
},
},
},
},
},
errors: [
{
code: 'xgen-IPA-117-request-response-bodies-must-be-well-defined',
message: 'Request and response bodies must have a schema.',
path: ['paths', '/resource/{id}', 'delete', 'requestBody', 'content', 'application/vnd.atlas.2024-08-05+json'],
severity: DiagnosticSeverity.Error,
},
],
},
{
name: 'invalid requests and responses',
document: {
Expand Down
2 changes: 1 addition & 1 deletion tools/spectral/ipa/rulesets/functions/IPA117RequestResponseBodiesMustBeWellDefined.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default (input, opts, { path, documentInventory, rule }) => {
// Custom POST method 2xx responses
if (
httpResponseCode === '202' ||
(httpMethod === 'delete' && httpResponseCode.startsWith('2')) ||
(httpMethod === 'delete' && httpResponseCode?.startsWith('2')) ||
(operationIsCustomMethod && httpMethod === 'post' && httpResponseCode?.startsWith('2'))
) {
return;
Expand Down
Loading