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.

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

fix: Store all Response examples by name #1571

Merged
merged 4 commits into from
Mar 17, 2024
Merged

fix: Store all Response examples by name #1571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70e5d9f
Store all Response examples by name
MiguelSavignano Mar 2, 2024
4a4df78
type Record
MiguelSavignano Mar 9, 2024
505d7cd
reanme responseExamplesByName
MiguelSavignano Mar 9, 2024
7bce2a9
test multiple response same status code
MiguelSavignano Mar 9, 2024
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
5 changes: 3 additions & 2 deletions packages/cli/src/metadataGeneration/methodGenerator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,17 +189,18 @@ export class MethodGenerator {
}

private getMethodResponses(): Tsoa.Response[] {
const responseExamplesByName: Record<string, any> = {};
const decorators = this.getDecoratorsByIdentifier(this.node, 'Response');
if (!decorators || !decorators.length) {
return [];
}

return decorators.map(decorator => {
const [name, description, example, produces] = getDecoratorValues(decorator, this.current.typeChecker);

responseExamplesByName[name] = responseExamplesByName[name] ? [...responseExamplesByName[name], example] : [example];
return {
description: description || '',
examples: example === undefined ? undefined : [example],
examples: responseExamplesByName[name] || undefined,
name: name || '200',
produces: this.getProducesAdapter(produces),
schema: this.getSchemaFromDecorator(decorator, 0),
Expand Down
3 changes: 2 additions & 1 deletion tests/fixtures/controllers/methodController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ export class MethodController extends Controller {
return new ModelService().getModel();
}

@Response<ErrorResponseModel>('400', 'Bad Request')
@Response<ErrorResponseModel>('400', 'Bad Request', { status: 400, message: 'reason 1' })
@Response<ErrorResponseModel>('400', 'Bad Request', { status: 400, message: 'reason 2' })
@Response<ErrorResponseModel>('401', 'Unauthorized')
@Response<ErrorResponseModel>('default', 'Unexpected error', { status: 500, message: 'Something went wrong!' })
@Get('MultiResponse')
Expand Down
11 changes: 6 additions & 5 deletions tests/unit/swagger/definitionsGeneration/metadata.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,22 +164,23 @@ describe('Metadata generation', () => {
throw new Error('Method multiResponse not defined!');
}

expect(method.responses.length).to.equal(4);
expect(method.responses.length).to.equal(5);

const badResponse = method.responses[0];
const badResponse = method.responses[1]
expect(badResponse.name).to.equal('400');
expect(badResponse.description).to.equal('Bad Request');
expect(badResponse.examples).to.deep.equal([{ status: 400, message: 'reason 1' }, { status: 400, message: 'reason 2' }]);

const unauthResponse = method.responses[1];
const unauthResponse = method.responses[2];
expect(unauthResponse.name).to.equal('401');
expect(unauthResponse.description).to.equal('Unauthorized');

const defaultResponse = method.responses[2];
const defaultResponse = method.responses[3];
expect(defaultResponse.name).to.equal('default');
expect(defaultResponse.description).to.equal('Unexpected error');
expect(defaultResponse.examples).to.deep.equal([{ status: 500, message: 'Something went wrong!' }]);

const successResponse = method.responses[3];
const successResponse = method.responses[4];
expect(successResponse.name).to.equal('200');
expect(successResponse.description).to.equal('Ok');
});
Expand Down
Loading