Add an HTTP API endpoint for runner registration. It enables managing the entire runner lifecycle using Forgejo's HTTP API. See https://code.forgejo.org/forgejo/forgejo-actions-feature-requests/issues/78 for background, design considerations, and usage. Example usage: ``` $ curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -H "Authorization: token 3fc3ef39805b0f811a5d7789cb7b448348d6bfbb" --data '{"name":"api-runner","description":"Lorem ipsum"}' http://localhost:3000/api/v1/user/actions/runners ``` ```json {"id":30,"uuid":"a5e33697-9f58-437d-83c3-551b6c6a6334","token":"cac45fa6726fe4e28f42598773671af28a3be121"} ``` ## 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. - [x] 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 - [ ] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10677 Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org> Co-authored-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch> Co-committed-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch>
246 lines
5.1 KiB
Go
246 lines
5.1 KiB
Go
// Copyright 2024 The Forgejo Authors. All rights reserved.
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package swagger
|
|
|
|
import (
|
|
ffed "forgejo.org/modules/forgefed"
|
|
api "forgejo.org/modules/structs"
|
|
"forgejo.org/services/forms"
|
|
)
|
|
|
|
// not actually a response, just a hack to get go-swagger to include definitions
|
|
// of the various XYZOption structs
|
|
|
|
// parameterBodies
|
|
// swagger:response parameterBodies
|
|
type swaggerParameterBodies struct {
|
|
// in:body
|
|
ForgeLike ffed.ForgeLike
|
|
|
|
// in:body
|
|
AddCollaboratorOption api.AddCollaboratorOption
|
|
|
|
// in:body
|
|
ReplaceFlagsOption api.ReplaceFlagsOption
|
|
|
|
// in:body
|
|
CreateEmailOption api.CreateEmailOption
|
|
// in:body
|
|
DeleteEmailOption api.DeleteEmailOption
|
|
|
|
// in:body
|
|
CreateHookOption api.CreateHookOption
|
|
// in:body
|
|
EditHookOption api.EditHookOption
|
|
|
|
// in:body
|
|
EditGitHookOption api.EditGitHookOption
|
|
|
|
// in:body
|
|
CreateIssueOption api.CreateIssueOption
|
|
// in:body
|
|
EditIssueOption api.EditIssueOption
|
|
// in:body
|
|
EditDeadlineOption api.EditDeadlineOption
|
|
|
|
// in:body
|
|
CreateIssueCommentOption api.CreateIssueCommentOption
|
|
// in:body
|
|
EditIssueCommentOption api.EditIssueCommentOption
|
|
// in:body
|
|
IssueMeta api.IssueMeta
|
|
|
|
// in:body
|
|
IssueLabelsOption api.IssueLabelsOption
|
|
|
|
// in:body
|
|
DeleteLabelsOption api.DeleteLabelsOption
|
|
|
|
// in:body
|
|
CreateKeyOption api.CreateKeyOption
|
|
|
|
// in:body
|
|
RenameUserOption api.RenameUserOption
|
|
|
|
// in:body
|
|
CreateLabelOption api.CreateLabelOption
|
|
// in:body
|
|
EditLabelOption api.EditLabelOption
|
|
|
|
// in:body
|
|
MarkupOption api.MarkupOption
|
|
// in:body
|
|
MarkdownOption api.MarkdownOption
|
|
|
|
// in:body
|
|
CreateMilestoneOption api.CreateMilestoneOption
|
|
// in:body
|
|
EditMilestoneOption api.EditMilestoneOption
|
|
|
|
// in:body
|
|
CreateOrgOption api.CreateOrgOption
|
|
// in:body
|
|
EditOrgOption api.EditOrgOption
|
|
|
|
// in:body
|
|
CreatePullRequestOption api.CreatePullRequestOption
|
|
// in:body
|
|
EditPullRequestOption api.EditPullRequestOption
|
|
// in:body
|
|
MergePullRequestOption forms.MergePullRequestForm
|
|
|
|
// in:body
|
|
CreateReleaseOption api.CreateReleaseOption
|
|
// in:body
|
|
EditReleaseOption api.EditReleaseOption
|
|
|
|
// in:body
|
|
CreateRepoOption api.CreateRepoOption
|
|
// in:body
|
|
EditRepoOption api.EditRepoOption
|
|
// in:body
|
|
UpdateBranchRepoOption api.UpdateBranchRepoOption
|
|
// in:body
|
|
TransferRepoOption api.TransferRepoOption
|
|
// in:body
|
|
CreateForkOption api.CreateForkOption
|
|
// in:body
|
|
GenerateRepoOption api.GenerateRepoOption
|
|
|
|
// in:body
|
|
CreateStatusOption api.CreateStatusOption
|
|
|
|
// in:body
|
|
CreateTeamOption api.CreateTeamOption
|
|
// in:body
|
|
EditTeamOption api.EditTeamOption
|
|
|
|
// in:body
|
|
AddTimeOption api.AddTimeOption
|
|
|
|
// in:body
|
|
CreateUserOption api.CreateUserOption
|
|
|
|
// in:body
|
|
EditUserOption api.EditUserOption
|
|
|
|
// in:body
|
|
EditAttachmentOptions api.EditAttachmentOptions
|
|
|
|
// in:body
|
|
ChangeFilesOptions api.ChangeFilesOptions
|
|
|
|
// in:body
|
|
CreateFileOptions api.CreateFileOptions
|
|
|
|
// in:body
|
|
UpdateFileOptions api.UpdateFileOptions
|
|
|
|
// in:body
|
|
DeleteFileOptions api.DeleteFileOptions
|
|
|
|
// in:body
|
|
CommitDateOptions api.CommitDateOptions
|
|
|
|
// in:body
|
|
RepoTopicOptions api.RepoTopicOptions
|
|
|
|
// in:body
|
|
EditReactionOption api.EditReactionOption
|
|
|
|
// in:body
|
|
CreateBranchRepoOption api.CreateBranchRepoOption
|
|
|
|
// in:body
|
|
CreateBranchProtectionOption api.CreateBranchProtectionOption
|
|
|
|
// in:body
|
|
EditBranchProtectionOption api.EditBranchProtectionOption
|
|
|
|
// in:body
|
|
CreateOAuth2ApplicationOptions api.CreateOAuth2ApplicationOptions
|
|
|
|
// in:body
|
|
CreatePullReviewOptions api.CreatePullReviewOptions
|
|
|
|
// in:body
|
|
CreatePullReviewComment api.CreatePullReviewComment
|
|
|
|
// in:body
|
|
CreatePullReviewCommentOptions api.CreatePullReviewCommentOptions
|
|
|
|
// in:body
|
|
SubmitPullReviewOptions api.SubmitPullReviewOptions
|
|
|
|
// in:body
|
|
DismissPullReviewOptions api.DismissPullReviewOptions
|
|
|
|
// in:body
|
|
MigrateRepoOptions api.MigrateRepoOptions
|
|
|
|
// in:body
|
|
PullReviewRequestOptions api.PullReviewRequestOptions
|
|
|
|
// in:body
|
|
CreateTagOption api.CreateTagOption
|
|
|
|
// in:body
|
|
CreateTagProtectionOption api.CreateTagProtectionOption
|
|
|
|
// in:body
|
|
EditTagProtectionOption api.EditTagProtectionOption
|
|
|
|
// in:body
|
|
CreateAccessTokenOption api.CreateAccessTokenOption
|
|
|
|
// in:body
|
|
UserSettingsOptions api.UserSettingsOptions
|
|
|
|
// in:body
|
|
CreateWikiPageOptions api.CreateWikiPageOptions
|
|
|
|
// in:body
|
|
CreatePushMirrorOption api.CreatePushMirrorOption
|
|
|
|
// in:body
|
|
UpdateUserAvatarOptions api.UpdateUserAvatarOption
|
|
|
|
// in:body
|
|
UpdateRepoAvatarOptions api.UpdateRepoAvatarOption
|
|
|
|
// in:body
|
|
CreateOrUpdateSecretOption api.CreateOrUpdateSecretOption
|
|
|
|
// in:body
|
|
CreateVariableOption api.CreateVariableOption
|
|
|
|
// in:body
|
|
RenameOrgOption api.RenameOrgOption
|
|
|
|
// in:body
|
|
UpdateVariableOption api.UpdateVariableOption
|
|
|
|
// in:body
|
|
DispatchWorkflowOption api.DispatchWorkflowOption
|
|
|
|
// in:body
|
|
CreateQuotaGroupOptions api.CreateQuotaGroupOptions
|
|
|
|
// in:body
|
|
CreateQuotaRuleOptions api.CreateQuotaRuleOptions
|
|
|
|
// in:body
|
|
EditQuotaRuleOptions api.EditQuotaRuleOptions
|
|
|
|
// in:body
|
|
SetUserQuotaGroupsOptions api.SetUserQuotaGroupsOptions
|
|
|
|
// in:body
|
|
NoteOptions api.NoteOptions
|
|
|
|
// in:body
|
|
RegisterRunnerOptions api.RegisterRunnerOptions
|
|
}
|