mirror of
https://github.com/go-gitea/gitea.git
synced 2025-04-27 19:36:07 +00:00
21b43fce08
Implements runner apis based on https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#list-self-hosted-runners-for-an-organization - Add Post endpoints for registration-token, google/go-github revealed this as problem - We should deprecate Get Endpoints, leaving them for compatibility - Get endpoint of admin has api path /admin/runners/registration-token that feels wrong, /admin/actions/runners/registration-token seems more consistent with user/org/repo api - Get Runner Api - List Runner Api - Delete Runner Api - Tests admin / user / org / repo level endpoints Related to #33750 (implements point 1 and 2) Via needs discovered in #32461, this runner api is needed to allow cleanup of runners that are deallocated without user interaction. --------- Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
105 lines
2.9 KiB
Go
105 lines
2.9 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package user
|
|
|
|
import (
|
|
"code.gitea.io/gitea/routers/api/v1/shared"
|
|
"code.gitea.io/gitea/services/context"
|
|
)
|
|
|
|
// https://docs.github.com/en/rest/actions/self-hosted-runners?apiVersion=2022-11-28#create-a-registration-token-for-an-organization
|
|
|
|
// GetRegistrationToken returns the token to register user runners
|
|
func GetRegistrationToken(ctx *context.APIContext) {
|
|
// swagger:operation GET /user/actions/runners/registration-token user userGetRunnerRegistrationToken
|
|
// ---
|
|
// summary: Get an user's actions runner registration token
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/RegistrationToken"
|
|
|
|
shared.GetRegistrationToken(ctx, ctx.Doer.ID, 0)
|
|
}
|
|
|
|
// CreateRegistrationToken returns the token to register user runners
|
|
func CreateRegistrationToken(ctx *context.APIContext) {
|
|
// swagger:operation POST /user/actions/runners/registration-token user userCreateRunnerRegistrationToken
|
|
// ---
|
|
// summary: Get an user's actions runner registration token
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/RegistrationToken"
|
|
|
|
shared.GetRegistrationToken(ctx, ctx.Doer.ID, 0)
|
|
}
|
|
|
|
// ListRunners get user-level runners
|
|
func ListRunners(ctx *context.APIContext) {
|
|
// swagger:operation GET /user/actions/runners user getUserRunners
|
|
// ---
|
|
// summary: Get user-level runners
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/definitions/ActionRunnersResponse"
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
shared.ListRunners(ctx, ctx.Doer.ID, 0)
|
|
}
|
|
|
|
// GetRunner get an user-level runner
|
|
func GetRunner(ctx *context.APIContext) {
|
|
// swagger:operation GET /user/actions/runners/{runner_id} user getUserRunner
|
|
// ---
|
|
// summary: Get an user-level runner
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: runner_id
|
|
// in: path
|
|
// description: id of the runner
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/definitions/ActionRunner"
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
shared.GetRunner(ctx, ctx.Doer.ID, 0, ctx.PathParamInt64("runner_id"))
|
|
}
|
|
|
|
// DeleteRunner delete an user-level runner
|
|
func DeleteRunner(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /user/actions/runners/{runner_id} user deleteUserRunner
|
|
// ---
|
|
// summary: Delete an user-level runner
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: runner_id
|
|
// in: path
|
|
// description: id of the runner
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// description: runner has been deleted
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
shared.DeleteRunner(ctx, ctx.Doer.ID, 0, ctx.PathParamInt64("runner_id"))
|
|
}
|