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

Jump to bottom

Swashbuckle annotations #203

Merged
merged 22 commits into from
Jul 1, 2024
Merged

Swashbuckle annotations #203

merged 22 commits into from
Jul 1, 2024

Conversation

TheTedder
Copy link
Contributor

Closes #168

@TheTedder TheTedder requested a review from a team as a code owner November 7, 2023 22:39
@zysim
Copy link
Collaborator

zysim commented Nov 8, 2023 •
edited
Loading

I honestly don't know if I prefer the look of this change. I feel bad that you've already put in the work on this, but things feel less readable, personally. On top of that, the attributes can't be folded away, which gets distracting.

@TheTedder
Copy link
Contributor Author

I honestly don't know if I prefer the look of this change. I feel bad that you've already put in the work on this, but things feel less readable, personally. On top of that, the attributes can't be folded away, which gets distracting.

I updated it just in case you change your mind. I think the openapi doc is actually more correct this way.

@zysim
Copy link
Collaborator

zysim commented Jun 30, 2024 •
edited
Loading

Honestly; this is fine. I'll merge this. nvm there's conflicts. I'll deal with it in a couple hours, if you haven't done so yourself, already.

zysim
zysim previously approved these changes Jun 30, 2024
View reviewed changes
@TheTedder
Add Swashbuckle.AspNetCore.Annotations depend.
6027a8f
@TheTedder
Enable annotations.
eea6577
@TheTedder
Convert AccountController::Register's XML comments to annotations.
c3b961f
@TheTedder
Use constructor instead of Summary property.
0620703
@TheTedder
Convert AccounController::Login XML comments to annotations.
627051b
@TheTedder
Replace AccountController::ResendConfirmation XML comments with annot…
7b22b05 
…ations.
@TheTedder
Remove unneeded param XML comment.
febef61
@TheTedder
Convert AccountController::RecoverAccount XML comments into annotations.
7fcba44
@TheTedder
Convert AccountController::ConfirmAccount XML comments to annotations.
e3c5998
@TheTedder
Add missing response types.
893f141
@TheTedder
Convert TestRecovery XML comments to annotations.
3ce2377
@TheTedder
Convert ResetPassword XML comments to annotations.
233ec9b
@TheTedder
Convert UserController XML comments to annotations.
d7c0f72
@TheTedder
Update openapi.json.
a427660
@TheTedder
Add missing 500 response.
85e14bb
@TheTedder
Update openapi.json.
47237ed
@TheTedder
Remove XML from swagger descriptions.
1ce7edb
@TheTedder
Add 400 and 500 errors to every controller.
203370d
@TheTedder
Fix up endpoint annotations.
d22484a
@TheTedder
Update openapi.json.
9b6dd34
@TheTedder
Delete conventions.
36f5a02
@TheTedder TheTedder requested a review from zysim July 1, 2024 02:12
zysim
zysim approved these changes Jul 1, 2024
View reviewed changes
Copy link
Collaborator

@zysim zysim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good enough for me. I like that we don't need to needlessly-annotate injected services anymore, as well. I wish we could make the error response schema more accurate (e.g. they all show status: 0 instead of the correct error code), but it's whatever. You can always just test out the API itself in the Swagger doc, anyway.

@zysim zysim merged commit 275d5d1 into leaderboardsgg:main Jul 1, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zysim zysim zysim approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use Swashbuckle.AspNetCore.Annotations
2 participants
@TheTedder @zysim