forgejo/routers/api/v1
Gusted 389b32f51a feat: make upload URL compatible with GitHub API (#9285)
Adds new a function, `AcceptsGithubResponse`, to the API router context struct to check if the requests accepts a Github response. Although Forgejo API will never be compatible with the Github API, historically Forgejo's API has been designed to follow that of Github closely and we know that a lot of tooling that uses the Github API can be used against the Forgejo API with little to no problem.

As a meet in the middle solution, this function can be used to respond with a more appropriate response that follows the Github API. This allows Forgejo to avoid breaking compatibility with existing users of the API and allows the API to be oh so slightly more compatible with that of Github for API clients that expect a Github response.

Because the `upload_url` field was added purely to match the Github API (forgejo/forgejo#580), it is fair to actually make it compatible with how the Github API intended it to be and that is by adding `{?name,label}` which is used by Github's Oktokit.

Only add `{?name,label}` when Forgejo knows the request accepts a Github response. This avoids breaking the API compatibility with non-Github API  clients.

Resolves Codeberg/Community#2132

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9285
Reviewed-by: 0ko <0ko@noreply.codeberg.org>
Reviewed-by: oliverpool <oliverpool@noreply.codeberg.org>
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2025-09-15 15:53:35 +02:00
..
activitypub Update Swagger annotations to reflect actual behavior (#9138) 2025-09-15 11:55:49 +02:00
admin chore: add email blocklist unit test 2025-08-30 09:45:19 +02:00
misc
notify Update Swagger annotations to reflect actual behavior (#9138) 2025-09-15 11:55:49 +02:00
org Update Swagger annotations to reflect actual behavior (#9138) 2025-09-15 11:55:49 +02:00
packages
repo feat: make upload URL compatible with GitHub API (#9285) 2025-09-15 15:53:35 +02:00
settings
shared Update Swagger annotations to reflect actual behavior (#9138) 2025-09-15 11:55:49 +02:00
swagger Update Swagger annotations to reflect actual behavior (#9138) 2025-09-15 11:55:49 +02:00
user Update Swagger annotations to reflect actual behavior (#9138) 2025-09-15 11:55:49 +02:00
utils feat: add sort parameter for users/search api endpoint (#8594) 2025-07-24 22:40:27 +02:00
api.go feat: Add converting mirror repos to normal to the API (#8932) 2025-09-14 14:25:05 +02:00