Skip to content
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.

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

fix: add support to delete requests with body #177

Merged
merged 2 commits into from
Aug 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions test/transforms/paths/requestBody.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,47 @@ describe('request body tests', () => {
expect(result).toEqual(expected);
});

it('should parse jsdoc request body for delete request', () => {
const jsdocInput = [`
/**
* DELETE /message
* @summary Delete messages listed under the specified tags
* @param {array<string>} request.body.required - Tags of the messages to delete
*/
`];
const expected = {
paths: {
'/message': {
delete: {
deprecated: false,
summary: 'Delete messages listed under the specified tags',
responses: {},
tags: [],
security: [],
parameters: [],
requestBody: {
description: 'Tags of the messages to delete',
required: true,
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'string',
},
},
},
},
},
},
},
},
};
const parsedJSDocs = jsdocInfo()(jsdocInput);
const result = setPaths({}, parsedJSDocs);
expect(result).toEqual(expected);
});

it('should parse jsdoc path multiple bodys', () => {
const jsodInput = [`
/**
Expand Down
2 changes: 1 addition & 1 deletion transforms/utils/httpMethods.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const validRequestBodyMethods = {
get: false,
delete: false,
delete: true,
head: false,
post: true,
put: true,
Expand Down