mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-28 22:14:20 -04:00
According to the GitHub API Spec: https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret Merge the Create and Update secret into a single API. - Remove the `CreateSecretOption` struct and replace it with `CreateOrUpdateSecretOption` in `modules/structs/secret.go` - Update the `CreateOrUpdateOrgSecret` function in `routers/api/v1/org/action.go` to use `CreateOrUpdateSecretOption` instead of `UpdateSecretOption` - Remove the `CreateOrgSecret` function in `routers/api/v1/org/action.go` and replace it with `CreateOrUpdateOrgSecret` - Update the Swagger documentation in `routers/api/v1/swagger/options.go` and `templates/swagger/v1_json.tmpl` to reflect the changes in the struct names and function names Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
177 lines
4.5 KiB
Go
177 lines
4.5 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package org
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
secret_model "code.gitea.io/gitea/models/secret"
|
|
"code.gitea.io/gitea/modules/context"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/web"
|
|
"code.gitea.io/gitea/routers/api/v1/utils"
|
|
"code.gitea.io/gitea/routers/web/shared/actions"
|
|
)
|
|
|
|
// ListActionsSecrets list an organization's actions secrets
|
|
func ListActionsSecrets(ctx *context.APIContext) {
|
|
// swagger:operation GET /orgs/{org}/actions/secrets organization orgListActionsSecrets
|
|
// ---
|
|
// summary: List an organization's actions secrets
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of the organization
|
|
// type: string
|
|
// required: true
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results to return (1-based)
|
|
// type: integer
|
|
// - name: limit
|
|
// in: query
|
|
// description: page size of results
|
|
// type: integer
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/SecretList"
|
|
|
|
listActionsSecrets(ctx)
|
|
}
|
|
|
|
// listActionsSecrets list an organization's actions secrets
|
|
func listActionsSecrets(ctx *context.APIContext) {
|
|
opts := &secret_model.FindSecretsOptions{
|
|
OwnerID: ctx.Org.Organization.ID,
|
|
ListOptions: utils.GetListOptions(ctx),
|
|
}
|
|
|
|
count, err := secret_model.CountSecrets(ctx, opts)
|
|
if err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
secrets, err := secret_model.FindSecrets(ctx, *opts)
|
|
if err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
apiSecrets := make([]*api.Secret, len(secrets))
|
|
for k, v := range secrets {
|
|
apiSecrets[k] = &api.Secret{
|
|
Name: v.Name,
|
|
Created: v.CreatedUnix.AsTime(),
|
|
}
|
|
}
|
|
|
|
ctx.SetTotalCountHeader(count)
|
|
ctx.JSON(http.StatusOK, apiSecrets)
|
|
}
|
|
|
|
// create or update one secret of the organization
|
|
func CreateOrUpdateOrgSecret(ctx *context.APIContext) {
|
|
// swagger:operation PUT /orgs/{org}/actions/secrets/{secretname} organization updateOrgSecret
|
|
// ---
|
|
// summary: Create or Update a secret value in an organization
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of organization
|
|
// type: string
|
|
// required: true
|
|
// - name: secretname
|
|
// in: path
|
|
// description: name of the secret
|
|
// type: string
|
|
// required: true
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/CreateOrUpdateSecretOption"
|
|
// responses:
|
|
// "201":
|
|
// description: response when creating a secret
|
|
// "204":
|
|
// description: response when updating a secret
|
|
// "400":
|
|
// "$ref": "#/responses/error"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
secretName := ctx.Params(":secretname")
|
|
if err := actions.NameRegexMatch(secretName); err != nil {
|
|
ctx.Error(http.StatusBadRequest, "CreateOrUpdateOrgSecret", err)
|
|
return
|
|
}
|
|
opt := web.GetForm(ctx).(*api.CreateOrUpdateSecretOption)
|
|
err := secret_model.UpdateSecret(
|
|
ctx, ctx.Org.Organization.ID, 0, secretName, opt.Data,
|
|
)
|
|
if secret_model.IsErrSecretNotFound(err) {
|
|
_, err := secret_model.InsertEncryptedSecret(
|
|
ctx, ctx.Org.Organization.ID, 0, secretName, actions.ReserveLineBreakForTextarea(opt.Data),
|
|
)
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "InsertEncryptedSecret", err)
|
|
return
|
|
}
|
|
ctx.Status(http.StatusCreated)
|
|
return
|
|
}
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "UpdateSecret", err)
|
|
return
|
|
}
|
|
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|
|
|
|
// DeleteOrgSecret delete one secret of the organization
|
|
func DeleteOrgSecret(ctx *context.APIContext) {
|
|
// swagger:operation DELETE /orgs/{org}/actions/secrets/{secretname} organization deleteOrgSecret
|
|
// ---
|
|
// summary: Delete a secret in an organization
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: org
|
|
// in: path
|
|
// description: name of organization
|
|
// type: string
|
|
// required: true
|
|
// - name: secretname
|
|
// in: path
|
|
// description: name of the secret
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "204":
|
|
// description: delete one secret of the organization
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
secretName := ctx.Params(":secretname")
|
|
err := secret_model.DeleteSecret(
|
|
ctx, ctx.Org.Organization.ID, 0, secretName,
|
|
)
|
|
if secret_model.IsErrSecretNotFound(err) {
|
|
ctx.NotFound(err)
|
|
return
|
|
}
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "DeleteSecret", err)
|
|
return
|
|
}
|
|
|
|
ctx.Status(http.StatusNoContent)
|
|
}
|