From c01404a3734d43ad59519555fffc22cd9f16d6e2 Mon Sep 17 00:00:00 2001 From: Andreas Ahlenstorf Date: Wed, 11 Feb 2026 17:59:43 +0100 Subject: [PATCH] chore: remove deprecated auth methods from API docs (#11232) Remove the documentation for the deprecated authentication methods Token and AccessToken. The functionality remains in place because it's still in use. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. *The decision if the pull request will be shown in the release notes is up to the mergers / release team.* The content of the `release-notes/.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11232 Reviewed-by: Gusted Reviewed-by: Cyborus Co-authored-by: Andreas Ahlenstorf Co-committed-by: Andreas Ahlenstorf --- routers/api/v1/api.go | 12 ------------ templates/swagger/v1_json.tmpl | 18 ------------------ 2 files changed, 30 deletions(-) diff --git a/routers/api/v1/api.go b/routers/api/v1/api.go index d428294036..b8af31fa75 100644 --- a/routers/api/v1/api.go +++ b/routers/api/v1/api.go @@ -22,8 +22,6 @@ // // Security: // - BasicAuth : -// - Token : -// - AccessToken : // - AuthorizationHeaderToken : // - SudoParam : // - SudoHeader : @@ -32,16 +30,6 @@ // SecurityDefinitions: // BasicAuth: // type: basic -// Token: -// type: apiKey -// name: token -// in: query -// description: This authentication option is deprecated for removal in Forgejo v13.0.0. Please use AuthorizationHeaderToken instead. -// AccessToken: -// type: apiKey -// name: access_token -// in: query -// description: This authentication option is deprecated for removal in Forgejo v13.0.0. Please use AuthorizationHeaderToken instead. // AuthorizationHeaderToken: // type: apiKey // name: Authorization diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index db2ca9dc13..da3b14da92 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -31592,12 +31592,6 @@ } }, "securityDefinitions": { - "AccessToken": { - "description": "This authentication option is deprecated for removal in Forgejo v13.0.0. Please use AuthorizationHeaderToken instead.", - "type": "apiKey", - "name": "access_token", - "in": "query" - }, "AuthorizationHeaderToken": { "description": "API tokens must be prepended with \"token\" followed by a space.", "type": "apiKey", @@ -31624,24 +31618,12 @@ "type": "apiKey", "name": "X-FORGEJO-OTP", "in": "header" - }, - "Token": { - "description": "This authentication option is deprecated for removal in Forgejo v13.0.0. Please use AuthorizationHeaderToken instead.", - "type": "apiKey", - "name": "token", - "in": "query" } }, "security": [ { "BasicAuth": [] }, - { - "Token": [] - }, - { - "AccessToken": [] - }, { "AuthorizationHeaderToken": [] },