Skip to content

Commit b93811d

Browse files
committed
docs: update summary comments and descriptions in v1_json.tmpl template file
- Update the `UpdateSecretOption` struct in `modules/structs/secret.go` - Update the summary comment for the `UpdateOrgSecret` function in `routers/api/v1/org/action.go` - Update the summary comment for the `v1_json.tmpl` template file in `templates/swagger` - Update the description for a field in the `v1_json.tmpl` template file in `templates/swagger` - Update the description for another field in the `v1_json.tmpl` template file in `templates/swagger` - Update the description for a third field in the `v1_json.tmpl` template file in `templates/swagger` - Update the description for a fourth field in the `v1_json.tmpl` template file in `templates/swagger` - Update the description for a fifth field in the `v1_json.tmpl` template file in `templates/swagger` Signed-off-by: Bo-Yi Wu <[email protected]>
1 parent 94eba30 commit b93811d

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

modules/structs/secret.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ type CreateSecretOption struct {
2929
// UpdateSecretOption options when updating secret
3030
// swagger:model
3131
type UpdateSecretOption struct {
32-
// Data of the secret to create
32+
// Data of the secret to update
3333
//
3434
// required: true
3535
Data string `json:"data" binding:"Required"`

routers/api/v1/org/action.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ func CreateOrgSecret(ctx *context.APIContext) {
118118
func UpdateOrgSecret(ctx *context.APIContext) {
119119
// swagger:operation PUT /orgs/{org}/actions/secrets/{secretname} organization updateOrgSecret
120120
// ---
121-
// summary: Update a secret in an organization
121+
// summary: Update a secret value in an organization
122122
// consumes:
123123
// - application/json
124124
// produces:

templates/swagger/v1_json.tmpl

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)