diff options
author | Bo-Yi Wu <appleboy.tw@gmail.com> | 2023-08-22 11:20:34 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-08-22 11:20:34 +0800 |
commit | 23addde28ebd69ef2c1cec6a63123c87ec8bffe9 (patch) | |
tree | 6b4327eeef013f38bc7cc332b653bbddb9b43d8d /templates/swagger | |
parent | a4a567f29f69e39d57a9fa7008d708f7fd080e58 (diff) | |
download | gitea-23addde28ebd69ef2c1cec6a63123c87ec8bffe9.tar.gz gitea-23addde28ebd69ef2c1cec6a63123c87ec8bffe9.zip |
feat: implement organization secret creation API (#26566)
- Add a new `CreateSecretOption` struct for creating secrets
- Implement a `CreateOrgSecret` function to create a secret in an
organization
- Add a new route in `api.go` to handle the creation of organization
secrets
- Update the Swagger template to include the new `CreateOrgSecret` API
endpoint
---------
Signed-off-by: appleboy <appleboy.tw@gmail.com>
Diffstat (limited to 'templates/swagger')
-rw-r--r-- | templates/swagger/v1_json.tmpl | 74 |
1 files changed, 72 insertions, 2 deletions
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 734a73bc0c..5e75f6f8b4 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -1586,6 +1586,49 @@ "$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}/activities/feeds": { @@ -17443,6 +17486,27 @@ }, "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", @@ -21334,7 +21398,7 @@ "x-go-package": "code.gitea.io/gitea/modules/structs" }, "Secret": { - "description": "User represents a secret", + "description": "Secret represents a secret", "type": "object", "properties": { "created_at": { @@ -22921,6 +22985,12 @@ "$ref": "#/definitions/SearchResults" } }, + "Secret": { + "description": "Secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, "SecretList": { "description": "SecretList", "schema": { @@ -23137,7 +23207,7 @@ "parameterBodies": { "description": "parameterBodies", "schema": { - "$ref": "#/definitions/UpdateRepoAvatarOption" + "$ref": "#/definitions/CreateSecretOption" } }, "redirect": { |