diff options
author | Bo-Yi Wu <appleboy.tw@gmail.com> | 2023-08-28 13:08:19 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-08-28 13:08:19 +0800 |
commit | 8cd46024fdcdaf04cd09be2c25db673e99b0a024 (patch) | |
tree | f8ea47b6a473ec43b35be215fce2755c7e7b363c /templates | |
parent | 6945918d34ecc855c99bfc7d7773c3a2d60a3565 (diff) | |
download | gitea-8cd46024fdcdaf04cd09be2c25db673e99b0a024.tar.gz gitea-8cd46024fdcdaf04cd09be2c25db673e99b0a024.zip |
refactor(API): refactor secret creation and update functionality (#26751)
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>
Diffstat (limited to 'templates')
-rw-r--r-- | templates/swagger/v1_json.tmpl | 108 |
1 files changed, 25 insertions, 83 deletions
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index ca4e1c4606..d37f4463f5 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -1586,49 +1586,6 @@ "$ref": "#/responses/SecretList" } } - }, - "post": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "tags": [ - "organization" - ], - "summary": "Create a secret in an organization", - "operationId": "createOrgSecret", - "parameters": [ - { - "type": "string", - "description": "name of organization", - "name": "org", - "in": "path", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/CreateSecretOption" - } - } - ], - "responses": { - "201": { - "$ref": "#/responses/Secret" - }, - "400": { - "$ref": "#/responses/error" - }, - "403": { - "$ref": "#/responses/forbidden" - }, - "404": { - "$ref": "#/responses/notFound" - } - } } }, "/orgs/{org}/actions/secrets/{secretname}": { @@ -1642,7 +1599,7 @@ "tags": [ "organization" ], - "summary": "Update a secret value in an organization", + "summary": "Create or Update a secret value in an organization", "operationId": "updateOrgSecret", "parameters": [ { @@ -1663,13 +1620,19 @@ "name": "body", "in": "body", "schema": { - "$ref": "#/definitions/UpdateSecretOption" + "$ref": "#/definitions/CreateOrUpdateSecretOption" } } ], "responses": { + "201": { + "description": "response when creating a secret" + }, "204": { - "description": "update one secret of the organization" + "description": "response when updating a secret" + }, + "400": { + "$ref": "#/responses/error" }, "403": { "$ref": "#/responses/forbidden" @@ -17283,6 +17246,21 @@ }, "x-go-package": "code.gitea.io/gitea/modules/structs" }, + "CreateOrUpdateSecretOption": { + "description": "CreateOrUpdateSecretOption options when creating or updating secret", + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "description": "Data of the secret to update", + "type": "string", + "x-go-name": "Data" + } + }, + "x-go-package": "code.gitea.io/gitea/modules/structs" + }, "CreateOrgOption": { "description": "CreateOrgOption options for creating an organization", "type": "object", @@ -17569,27 +17547,6 @@ }, "x-go-package": "code.gitea.io/gitea/modules/structs" }, - "CreateSecretOption": { - "description": "CreateSecretOption options when creating secret", - "type": "object", - "required": [ - "name" - ], - "properties": { - "data": { - "description": "Data of the secret to create", - "type": "string", - "x-go-name": "Data" - }, - "name": { - "description": "Name of the secret to create", - "type": "string", - "uniqueItems": true, - "x-go-name": "Name" - } - }, - "x-go-package": "code.gitea.io/gitea/modules/structs" - }, "CreateStatusOption": { "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit", "type": "object", @@ -21978,21 +21935,6 @@ }, "x-go-package": "code.gitea.io/gitea/modules/structs" }, - "UpdateSecretOption": { - "description": "UpdateSecretOption options when updating secret", - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "description": "Data of the secret to update", - "type": "string", - "x-go-name": "Data" - } - }, - "x-go-package": "code.gitea.io/gitea/modules/structs" - }, "UpdateUserAvatarOption": { "description": "UpdateUserAvatarUserOption options when updating the user avatar", "type": "object", @@ -23309,7 +23251,7 @@ "parameterBodies": { "description": "parameterBodies", "schema": { - "$ref": "#/definitions/UpdateSecretOption" + "$ref": "#/definitions/CreateOrUpdateSecretOption" } }, "redirect": { |