Skip to content

utoipa: Add annotations to (almost) all endpoints #10201

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
Merged
merged 43 commits into from
Dec 15, 2024
Merged

utoipa: Add annotations to (almost) all endpoints #10201

merged 43 commits into from
Dec 15, 2024

Conversation

Turbo87
Copy link
Member

@Turbo87 Turbo87 commented Dec 13, 2024 •
edited
Loading

This PR continues what #10186 started. It migrates (almost) all of our API endpoints to utoipa with a set of very basic annotations. The next step will be to add path and query parameters and request/response body schemas. Also missing is authentication schemes, but this PR should be a good starting point to add them :)

Bildschirmfoto 2024-12-13 um 18 56 33

@Turbo87 Turbo87 added C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works A-backend ⚙️ labels Dec 13, 2024
@Turbo87 Turbo87 requested a review from a team December 13, 2024 18:13
eth3lbert
eth3lbert approved these changes Dec 15, 2024
View reviewed changes
Copy link
Contributor

@eth3lbert eth3lbert left a comment

Choose a reason for hiding this comment

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

I only skimmed through the routes. I think CI would watch out for the rest of the parts, and it seems all good 👍 We now have an overview of the routes, and it also covers deprecated status. I think this is a good enough start :)

Thanks for the work!

Turbo87 added 25 commits December 15, 2024 10:59
@Turbo87
utoipa: Add annotations to /crates/new endpoints
82aa90f
@Turbo87
utoipa: Add annotations to /crates/{name}/owners endpoints
08c6e4b
@Turbo87
utoipa: Add annotations to /crates/{name}/{version}/yank endpoints
4acb47f
@Turbo87
utoipa: Add annotations to /crates/{name}/{version}/unyank endpoints
fc5f2ce
@Turbo87
utoipa: Add annotations to /crates/{name}/{version}/download endpoints
9000960
@Turbo87
utoipa: Add annotations to /crates/{name} endpoints
ea9b50e
@Turbo87
utoipa: Add annotations to /crates/{name}/{version} endpoints
9d0a123
@Turbo87
utoipa: Add annotations to /crates/{name}/{version}/readme endpoints
f79f4d5
@Turbo87
utoipa: Add annotations to /crates/{name}/{version}/dependencies en…
5eb53e3 
…dpoints
@Turbo87
utoipa: Add annotations to /crates/{name}/{version}/downloads endpo…
96ff166 
…ints
@Turbo87
utoipa: Add annotations to /crates/{name}/{version}/authors endpoints
f19c6f4
@Turbo87
utoipa: Add annotations to /crates/{name}/downloads endpoints
24090fd
@Turbo87
utoipa: Add annotations to /crates/{name}/versions endpoints
5c1d82d
@Turbo87
utoipa: Add annotations to /crates/{name}/follow endpoints
c9d9c29
@Turbo87
utoipa: Add annotations to /crates/{name}/following endpoints
b740a46
@Turbo87
utoipa: Add annotations to /crates/{name}/owner_team endpoints
5fa4b1f
@Turbo87
utoipa: Add annotations to /crates/{name}/owner_user endpoints
b8f8fef
@Turbo87
utoipa: Add annotations to /crates/{name}/reverse_dependencies endp…
5777f08 
…oints
@Turbo87
utoipa: Add annotations to /keywords endpoints
8cf41e0
@Turbo87
utoipa: Add annotations to /keywords/{keyword} endpoints
5115053
@Turbo87
utoipa: Add annotations to /categories endpoints
cb7c686
@Turbo87
utoipa: Add annotations to /categories/{category} endpoints
ec22ad1
@Turbo87
utoipa: Add annotations to /category_slugs endpoints
42f64e4
@Turbo87
utoipa: Add annotations to /users/{user} endpoints
ccba727
@Turbo87
utoipa: Add annotations to /users/{id}/stats endpoints
949634b
Turbo87 added 18 commits December 15, 2024 10:59
@Turbo87
utoipa: Add annotations to /teams/{team} endpoints
3767cef
@Turbo87
utoipa: Add annotations to /me endpoints
67d13f7
@Turbo87
utoipa: Add annotations to /me/updates endpoints
dd4f192
@Turbo87
utoipa: Add annotations to /me/tokens endpoints
c5987ae
@Turbo87
utoipa: Add annotations to /me/tokens/{id} endpoints
2730095
@Turbo87
utoipa: Add annotations to /tokens/current endpoints
868d2da
@Turbo87
utoipa: Add annotations to /me/crate_owner_invitations endpoints
6dafec2
@Turbo87
utoipa: Add annotations to /me/crate_owner_invitations/{crate_id} e…
b68719b 
…ndpoints
@Turbo87
utoipa: Add annotations to `/me/crate_owner_invitations/accept/{token…
29ca13c 
…}` endpoints
@Turbo87
utoipa: Add annotations to /me/email_notifications endpoints
8346246
@Turbo87
utoipa: Add annotations to /summary endpoints
d0bb30b
@Turbo87
utoipa: Add annotations to /confirm/{email_token} endpoints
b2a3888
@Turbo87
utoipa: Add annotations to /users/{id}/resend endpoints
4a7d68e
@Turbo87
utoipa: Add annotations to /site_metadata endpoints
d7b2d4e
@Turbo87
utoipa: Add annotations to /private/session/begin endpoints
b03579c
@Turbo87
utoipa: Add annotations to /private/session/authorize endpoints
4c0ebe9
@Turbo87
utoipa: Add annotations to /private/session endpoints
3fec3e8
@Turbo87
utoipa: Add annotations to /private/crate_owner_invitations endpoints
dd69739
@Turbo87 Turbo87 enabled auto-merge December 15, 2024 10:03
@Turbo87 Turbo87 merged commit a093332 into rust-lang:main Dec 15, 2024
8 checks passed
@Turbo87 Turbo87 deleted the utoipa-router branch December 15, 2024 10:10
This was referenced Dec 15, 2024
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eth3lbert eth3lbert eth3lbert approved these changes

Assignees
No one assigned
Labels
A-backend ⚙️ C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Turbo87 @eth3lbert