Add API route to list org secrets #26485

appleboy · 2023-08-14T03:47:30Z

Add a new function CountOrgSecrets in the file models/secret/secret.go
Add a new file modules/structs/secret.go
Add a new function ListActionsSecrets in the file routers/api/v1/api.go
Add a new file routers/api/v1/org/action.go
Add a new function listActionsSecrets in the file routers/api/v1/org/action.go

go-sdk: https://gitea.com/gitea/go-sdk/pulls/629

- Add a new function `CountOrgSecrets` in the file `models/secret/secret.go` - Add a new file `modules/structs/secret.go` - Add a new function `ListActionsSecrets` in the file `routers/api/v1/api.go` - Add a new file `routers/api/v1/org/action.go` - Add a new function `listActionsSecrets` in the file `routers/api/v1/org/action.go` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

models/secret/secret.go

modules/structs/secret.go

routers/api/v1/org/action.go

- Add a new API endpoint for listing an organization's actions secrets Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>

Co-authored-by: techknowlogick <matti@mdranta.net>

- Add a new file `routers/api/v1/swagger/action.go` - Add a new struct `swaggerResponseSecretList` in the `action.go` file - Add a new file `templates/swagger/v1_json.tmpl` - Modify the `v1_json.tmpl` file to include a new property `Secret` in the `properties` section of the `User` object - Modify the `v1_json.tmpl` file to include a new definition `SecretList` in the `definitions` section Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

- Change the function name from `FindSecrets` to `CountSecrets` in `models/secret/secret.go` - Change the function name from `CountOrgSecrets` to `CountSecrets` in `routers/api/v1/org/action.go` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

routers/api/v1/org/action.go

routers/api/v1/api.go

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>

delvh · 2023-08-14T09:38:55Z

routers/api/v1/org/action.go

+
+// ListActionsSecrets list an organization's actions secrets
+func ListActionsSecrets(ctx *context.APIContext) {
+	// swagger:operation GET /orgs/{org}/actions/secrets organization orgListActionsSecrets


Erm… User secrets exist too already.

That and we were not sure if we keep them action-only.
I think it is better to omit the actions/ part from the URL.

Or do you explicitly only want to return the action secrets here?

Just following the spec: https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#list-organization-secrets

So, what do we do in this case?
Deviate from the GitHub standard?
Add extra routes, and mark this one as deprecated with a comment only for compatibility with the GitHub API?

I'm sorry if my previous response was unclear. Please provide more details or elaborate on what you want me to explain. Thank you.

We try to be compatible with GitHub API where possible, so far so good

I think this is the wrong URL for that route, I suggest /orgs/{org}/secrets//users/{user}/secrets instead

That leaves the question what to do with the missing URL.
I suggest adding three routes in this PR: The two mentioned above, and the one you already implemented.
However, as the third should only be used by existing scripts and nothing else, I recommend marking this route as // deprecated: true with a comment that it is only intended for GitHub API compatibility and that our routes are the other two above instead.

As I said in #24200 (comment) , we can provide other API routes for more purposes but share the data table.

So LGTM.

routers/api/v1/org/action.go

modules/structs/secret.go

- Rename the `Created` field to `created_at` in the `Secret` struct Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

- Change the property name from "created" to "created_at" in the User object Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

wolfogre · 2023-08-15T01:58:35Z

If I read the code correctly, there is no route to list user secrets, only org secrets. I'm OK with that if we don't want to do that in this PR, but please update the title.

appleboy · 2023-08-15T02:05:34Z

@wolfogre done for changed the PR title.

…n status - Remove unnecessary code for checking organization membership and admin status in `ListActionsSecrets` function Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

appleboy · 2023-08-15T08:10:54Z

@delvh any feedback? or we can merge the PR.

delvh · 2023-08-15T08:33:31Z

No block from my side, if we want to be compatible with the GitHub API.

* upstream/main: Sync repo's IsEmpty status correctly (go-gitea#26517) [skip ci] Updated translations via Crowdin Remove fomantic transition module (go-gitea#26469) Explain SearchOptions and fix ToSearchOptions (go-gitea#26542) Update go dependencies (go-gitea#26534) Differentiate better between user settings and admin settings (go-gitea#26538) Add missing triggers to update issue indexer (go-gitea#26539) Improve deadline icon location in milestone list page (go-gitea#26532) Use unique class for breadcrumb divider (go-gitea#26524) Fix typo of RunerOwnerID (go-gitea#26508) Improve clickable area in repo action view page (go-gitea#26115) Fix dark theme highlight for "NameNamespace" (go-gitea#26519) Remove duplicate CSS import for chroma/base.css (go-gitea#26523) Fix project filter bugs (go-gitea#26490) Fix display problems of members and teams unit (go-gitea#26363) Use `hidden` over `clip` for text truncation (go-gitea#26520) Add API route to list org secrets (go-gitea#26485) Set "type=button" for editor's toolbar buttons (go-gitea#26510) Apply to become a maintainer (go-gitea#26514) Detect ogg mime-type as audio or video (go-gitea#26494)

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Aug 14, 2023

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 14, 2023

appleboy changed the title ~~feat: add new functions and files related to secrets management~~ feat(secrets): add new functions and files related to secrets management Aug 14, 2023

appleboy requested review from lunny and wolfogre August 14, 2023 03:48

lunny reviewed Aug 14, 2023

View reviewed changes

models/secret/secret.go Outdated Show resolved Hide resolved

techknowlogick reviewed Aug 14, 2023

View reviewed changes

modules/structs/secret.go Outdated Show resolved Hide resolved

techknowlogick reviewed Aug 14, 2023

View reviewed changes

routers/api/v1/org/action.go Outdated Show resolved Hide resolved

appleboy and others added 9 commits August 14, 2023 13:09

feat: add API endpoint for listing organization's actions secrets

3fd8201

- Add a new API endpoint for listing an organization's actions secrets Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Update models/secret/secret.go

ae362b5

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>

Update modules/structs/secret.go

8a502a2

Co-authored-by: techknowlogick <matti@mdranta.net>

Update routers/api/v1/org/action.go

b54742d

Co-authored-by: techknowlogick <matti@mdranta.net>

Merge branch 'api' of https://github.com/appleboy/gitea into api

bdf18bb

backup

ab59235

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Merge branch 'main' into api

473b027

lunny reviewed Aug 14, 2023

View reviewed changes

routers/api/v1/org/action.go Show resolved Hide resolved

lunny reviewed Aug 14, 2023

View reviewed changes

routers/api/v1/api.go Outdated Show resolved Hide resolved

Update routers/api/v1/api.go

5dc1f25

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>

lunny added type/enhancement An improvement of existing functionality modifies/api This PR adds API routes or modifies them labels Aug 14, 2023

lunny added this to the 1.21.0 milestone Aug 14, 2023

lunny approved these changes Aug 14, 2023

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Aug 14, 2023

delvh reviewed Aug 14, 2023

View reviewed changes

delvh changed the title ~~feat(secrets): add new functions and files related to secrets management~~ Add API routes to list org/user secrets Aug 14, 2023

refactor: refactor Secret struct field name to created_at

ff80b03

- Rename the `Created` field to `created_at` in the `Secret` struct Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

appleboy added 3 commits August 14, 2023 21:01

Merge branch 'main' into api

dba1714

refactor: refactor property name in User object

d72bcee

- Change the property name from "created" to "created_at" in the User object Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Merge branch 'main' into api

50ce300

appleboy changed the title ~~Add API routes to list org/user secrets~~ Add API routes to list org secrets Aug 15, 2023

appleboy force-pushed the api branch from b6f55f0 to 50ce300 Compare August 15, 2023 02:08

appleboy added 3 commits August 15, 2023 10:09

Merge branch 'main' into api

f5e05f8

refactor: refactor code for checking organization membership and admi…

26beefd

…n status - Remove unnecessary code for checking organization membership and admin status in `ListActionsSecrets` function Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

Merge branch 'api' of https://github.com/appleboy/gitea into api

3e162be

wolfogre approved these changes Aug 15, 2023

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Aug 15, 2023

Merge branch 'main' into api

1a829f8

delvh changed the title ~~Add API routes to list org secrets~~ Add API route to list org secrets Aug 15, 2023

lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Aug 15, 2023

GiteaBot added 2 commits August 15, 2023 18:38

Merge branch 'main' into api

f15ad0e

Merge branch 'main' into api

4c7efe4

silverwind approved these changes Aug 15, 2023

View reviewed changes

silverwind merged commit 79d74d2 into go-gitea:main Aug 15, 2023
24 checks passed

GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Aug 15, 2023

appleboy deleted the api branch August 15, 2023 12:56

go-gitea locked as resolved and limited conversation to collaborators Nov 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add API route to list org secrets #26485

Add API route to list org secrets #26485

appleboy commented Aug 14, 2023 •

edited

delvh Aug 14, 2023

delvh Aug 14, 2023

delvh Aug 14, 2023

appleboy Aug 14, 2023

delvh Aug 14, 2023 •

edited

appleboy Aug 14, 2023

delvh Aug 14, 2023

wolfogre Aug 15, 2023

wolfogre commented Aug 15, 2023

appleboy commented Aug 15, 2023 •

edited

appleboy commented Aug 15, 2023

delvh commented Aug 15, 2023

Add API route to list org secrets #26485

Add API route to list org secrets #26485

Conversation

appleboy commented Aug 14, 2023 • edited

delvh Aug 14, 2023

Choose a reason for hiding this comment

delvh Aug 14, 2023

Choose a reason for hiding this comment

delvh Aug 14, 2023

Choose a reason for hiding this comment

appleboy Aug 14, 2023

Choose a reason for hiding this comment

delvh Aug 14, 2023 • edited

Choose a reason for hiding this comment

appleboy Aug 14, 2023

Choose a reason for hiding this comment

delvh Aug 14, 2023

Choose a reason for hiding this comment

wolfogre Aug 15, 2023

Choose a reason for hiding this comment

wolfogre commented Aug 15, 2023

appleboy commented Aug 15, 2023 • edited

appleboy commented Aug 15, 2023

delvh commented Aug 15, 2023

appleboy commented Aug 14, 2023 •

edited

delvh Aug 14, 2023 •

edited

appleboy commented Aug 15, 2023 •

edited