diff --git a/routers/api/v1/admin/runners.go b/routers/api/v1/admin/runners.go index 81c029c57c..db62979b62 100644 --- a/routers/api/v1/admin/runners.go +++ b/routers/api/v1/admin/runners.go @@ -9,10 +9,16 @@ import ( ) // GetRunnerRegistrationToken returns a token to register global runners +// +// Deprecated: This operation has been deprecated in Forgejo 15. Use the web UI or RegisterRunner instead. func GetRunnerRegistrationToken(ctx *context.APIContext) { // swagger:operation GET /admin/actions/runners/registration-token admin adminGetRunnerRegistrationToken // --- // summary: Get a runner registration token for registering global runners + // description: > + // This operation has been deprecated in Forgejo 15. + // Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead. + // deprecated: true // produces: // - application/json // parameters: @@ -25,14 +31,14 @@ func GetRunnerRegistrationToken(ctx *context.APIContext) { // GetRegistrationToken returns the token to register global runners // -// Deprecated: This operation has been deprecated in Forgejo 15. Use GetRunnerRegistrationToken instead. +// Deprecated: This operation has been deprecated in Forgejo 15. Use the web UI or RegisterRunner instead. func GetRegistrationToken(ctx *context.APIContext) { // swagger:operation GET /admin/runners/registration-token admin adminGetRegistrationToken // --- // summary: Get a runner registration token for registering global runners // description: > // This operation has been deprecated in Forgejo 15. - // Use [`/admin/actions/runners/registration-token`](#/admin/adminGetRunnerRegistrationToken) instead. + // Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead. // deprecated: true // produces: // - application/json diff --git a/routers/api/v1/api.go b/routers/api/v1/api.go index ce013e7fdb..f551f20c6a 100644 --- a/routers/api/v1/api.go +++ b/routers/api/v1/api.go @@ -1010,7 +1010,7 @@ func Routes() *web.Route { m.Combo(""). Get(reqToken(), user.ListRunners). Post(bind(api.RegisterRunnerOptions{}), user.RegisterRunner) - m.Get("/registration-token", reqToken(), user.GetRegistrationToken) + m.Get("/registration-token", reqToken(), user.GetRegistrationToken) //nolint:staticcheck m.Get("/{runner_id}", reqToken(), user.GetRunner) m.Delete("/{runner_id}", reqToken(), user.DeleteRunner) m.Get("/jobs", reqToken(), user.SearchActionRunJobs) @@ -1694,7 +1694,7 @@ func Routes() *web.Route { m.Combo(""). Get(admin.ListRunners). Post(bind(api.RegisterRunnerOptions{}), admin.RegisterRunner) - m.Get("/registration-token", admin.GetRunnerRegistrationToken) + m.Get("/registration-token", admin.GetRunnerRegistrationToken) //nolint:staticcheck m.Get("/{runner_id}", admin.GetRunner) m.Delete("/{runner_id}", admin.DeleteRunner) m.Get("/jobs", admin.GetActionRunJobs) diff --git a/routers/api/v1/org/action.go b/routers/api/v1/org/action.go index dac6704d4b..6036d476f7 100644 --- a/routers/api/v1/org/action.go +++ b/routers/api/v1/org/action.go @@ -168,11 +168,17 @@ func (Action) DeleteSecret(ctx *context.APIContext) { ctx.Status(http.StatusNoContent) } -// GetRegistrationToken returns the organization's runner registration token +// GetRegistrationToken returns the organization's runner registration token. +// +// Deprecated: This operation has been deprecated in Forgejo 15. Use the web UI or RegisterRunner instead. func (Action) GetRegistrationToken(ctx *context.APIContext) { // swagger:operation GET /orgs/{org}/actions/runners/registration-token organization orgGetRunnerRegistrationToken // --- // summary: Get the organization's runner registration token + // description: > + // This operation has been deprecated in Forgejo 15. + // Use the web UI or [`/orgs/{org}/actions/runners`](#/organization/registerOrgRunner) instead. + // deprecated: true // produces: // - application/json // parameters: diff --git a/routers/api/v1/repo/action.go b/routers/api/v1/repo/action.go index ab049e4383..94a25a088f 100644 --- a/routers/api/v1/repo/action.go +++ b/routers/api/v1/repo/action.go @@ -482,10 +482,16 @@ func (Action) ListVariables(ctx *context.APIContext) { } // GetRegistrationToken returns the runner registration token to register runners for the repository +// +// Deprecated: This operation has been deprecated in Forgejo 15. Use the web UI or RegisterRunner instead. func (Action) GetRegistrationToken(ctx *context.APIContext) { // swagger:operation GET /repos/{owner}/{repo}/actions/runners/registration-token repository repoGetRunnerRegistrationToken // --- // summary: Get a repository's runner registration token + // description: > + // This operation has been deprecated in Forgejo 15. + // Use the web UI or [`/repos/{owner}/{repo}/actions/runners`](#/repository/registerRepoRunner) instead. + // deprecated: true // produces: // - application/json // parameters: diff --git a/routers/api/v1/user/runners.go b/routers/api/v1/user/runners.go index 340233f27d..29bf13b982 100644 --- a/routers/api/v1/user/runners.go +++ b/routers/api/v1/user/runners.go @@ -9,10 +9,16 @@ import ( ) // GetRegistrationToken returns a token to register user-level runners +// +// Deprecated: This operation has been deprecated in Forgejo 15. Use the web UI or RegisterRunner instead. func GetRegistrationToken(ctx *context.APIContext) { // swagger:operation GET /user/actions/runners/registration-token user userGetRunnerRegistrationToken // --- // summary: Get the user's runner registration token + // description: > + // This operation has been deprecated in Forgejo 15. + // Use the web UI or [`/user/actions/runners`](#/user/registerUserRunner) instead. + // deprecated: true // produces: // - application/json // parameters: diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 7a800cc171..08bd72ef60 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -414,6 +414,7 @@ }, "/admin/actions/runners/registration-token": { "get": { + "description": "This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.\n", "produces": [ "application/json" ], @@ -422,6 +423,7 @@ ], "summary": "Get a runner registration token for registering global runners", "operationId": "adminGetRunnerRegistrationToken", + "deprecated": true, "responses": { "200": { "$ref": "#/responses/RegistrationToken" @@ -1347,7 +1349,7 @@ }, "/admin/runners/registration-token": { "get": { - "description": "This operation has been deprecated in Forgejo 15. Use [`/admin/actions/runners/registration-token`](#/admin/adminGetRunnerRegistrationToken) instead.\n", + "description": "This operation has been deprecated in Forgejo 15. Use the web UI or [`/admin/actions/runners`](#/admin/registerAdminRunner) instead.\n", "produces": [ "application/json" ], @@ -2833,6 +2835,7 @@ }, "/orgs/{org}/actions/runners/registration-token": { "get": { + "description": "This operation has been deprecated in Forgejo 15. Use the web UI or [`/orgs/{org}/actions/runners`](#/organization/registerOrgRunner) instead.\n", "produces": [ "application/json" ], @@ -2841,6 +2844,7 @@ ], "summary": "Get the organization's runner registration token", "operationId": "orgGetRunnerRegistrationToken", + "deprecated": true, "parameters": [ { "type": "string", @@ -5583,6 +5587,7 @@ }, "/repos/{owner}/{repo}/actions/runners/registration-token": { "get": { + "description": "This operation has been deprecated in Forgejo 15. Use the web UI or [`/repos/{owner}/{repo}/actions/runners`](#/repository/registerRepoRunner) instead.\n", "produces": [ "application/json" ], @@ -5591,6 +5596,7 @@ ], "summary": "Get a repository's runner registration token", "operationId": "repoGetRunnerRegistrationToken", + "deprecated": true, "parameters": [ { "type": "string", @@ -19086,6 +19092,7 @@ }, "/user/actions/runners/registration-token": { "get": { + "description": "This operation has been deprecated in Forgejo 15. Use the web UI or [`/user/actions/runners`](#/user/registerUserRunner) instead.\n", "produces": [ "application/json" ], @@ -19094,6 +19101,7 @@ ], "summary": "Get the user's runner registration token", "operationId": "userGetRunnerRegistrationToken", + "deprecated": true, "responses": { "200": { "$ref": "#/responses/RegistrationToken"