Features/resources api responses

[curtwl]

Description

Add @ApiResponse tags to team resources controller

Issue link

Fixes #66

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Tested with Swagger.

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[cherylli]

looks good, just a few minor things,

was the latest dev pulled into this branch?

should we put "examples" on the DTOs too?

There's an undocumented change here (the POST endpoint)

[cherylli]

Not sure if you noticed the 400 bad request response in the POST endpoint, the message part is an array, which is different from other responses. I think it might be because there are multiple validators.

Should we add another BadRequestErrorResponse (but with another name) for this?

[curtwl]

Not sure if you noticed the 400 bad request response in the POST endpoint, the message part is an array, which is different from other responses. I think it might be because there are multiple validators.

Should we add another BadRequestErrorResponse (but with another name) for this?

I see what you mean. Does this look good?

[cherylli]

Not sure if you noticed the 400 bad request response in the POST endpoint, the message part is an array, which is different from other responses. I think it might be because there are multiple validators.
Should we add another BadRequestErrorResponse (but with another name) for this?

I see what you mean. Does this look good?

yeah that looks good. thank you!

[smurph7894]

I think this also may need to pull some commits from the dev branch.

[jenny-alexander]

Looks good to me.

[jenny-alexander]

CGD-66: Add @ApiResponse tags to resources controllers.