Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(API): add routes and functions for managing user's secrets (#26909)
- Add routes for creating or updating a user's actions secrets in `routers/api/v1/api.go` - Add a new file `routers/api/v1/user/action.go` with functions for creating or updating a user's secrets and deleting a user's secret - Modify the `templates/swagger/v1_json.tmpl` file to include the routes for creating or updating a user's secrets and deleting a user's secret --------- Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
- Loading branch information
Showing
3 changed files
with
190 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
// Copyright 2023 The Gitea Authors. All rights reserved. | ||
// SPDX-License-Identifier: MIT | ||
|
||
package user | ||
|
||
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/web/shared/actions" | ||
) | ||
|
||
// create or update one secret of the user scope | ||
func CreateOrUpdateSecret(ctx *context.APIContext) { | ||
// swagger:operation PUT /user/actions/secrets/{secretname} user updateUserSecret | ||
// --- | ||
// summary: Create or Update a secret value in a user scope | ||
// consumes: | ||
// - application/json | ||
// produces: | ||
// - application/json | ||
// parameters: | ||
// - 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" | ||
// "404": | ||
// "$ref": "#/responses/notFound" | ||
|
||
secretName := ctx.Params(":secretname") | ||
if err := actions.NameRegexMatch(secretName); err != nil { | ||
ctx.Error(http.StatusBadRequest, "CreateOrUpdateSecret", err) | ||
return | ||
} | ||
opt := web.GetForm(ctx).(*api.CreateOrUpdateSecretOption) | ||
isCreated, err := secret_model.CreateOrUpdateSecret(ctx, ctx.Doer.ID, 0, secretName, opt.Data) | ||
if err != nil { | ||
ctx.Error(http.StatusInternalServerError, "CreateOrUpdateSecret", err) | ||
return | ||
} | ||
if isCreated { | ||
ctx.Status(http.StatusCreated) | ||
return | ||
} | ||
|
||
ctx.Status(http.StatusNoContent) | ||
} | ||
|
||
// DeleteSecret delete one secret of the user scope | ||
func DeleteSecret(ctx *context.APIContext) { | ||
// swagger:operation DELETE /user/actions/secrets/{secretname} user deleteUserSecret | ||
// --- | ||
// summary: Delete a secret in a user scope | ||
// consumes: | ||
// - application/json | ||
// produces: | ||
// - application/json | ||
// parameters: | ||
// - name: secretname | ||
// in: path | ||
// description: name of the secret | ||
// type: string | ||
// required: true | ||
// responses: | ||
// "204": | ||
// description: delete one secret of the user | ||
// "400": | ||
// "$ref": "#/responses/error" | ||
// "404": | ||
// "$ref": "#/responses/notFound" | ||
|
||
secretName := ctx.Params(":secretname") | ||
if err := actions.NameRegexMatch(secretName); err != nil { | ||
ctx.Error(http.StatusBadRequest, "DeleteSecret", err) | ||
return | ||
} | ||
err := secret_model.DeleteSecret( | ||
ctx, ctx.Doer.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) | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.