BlueGit

timfa bluegit

Files

bluegit / internal / server / api_routes.go

api_routes.go

feat: beschrijf de API-objecten en geef ze een web_url
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
Passed 2f39b617 History
api_routes.go 14.9 KiB Download Raw
1package server
2
3import (
4 "net/http"
5
6 "gitlab.com/Timfa/bluegit/internal/access"
7)
8
9var apiCatalog = []apiRoute{
10 {http.MethodGet, "/api/v1/ci/spec", access.ScopePublic, authPublic, "CI specification", (*Server).ciSpec},
11 {http.MethodGet, "/api/v1/ci/presets", access.ScopePublic, authPublic, "CI image presets", (*Server).apiPresets},
12
13 {http.MethodGet, "/api/v1/user", access.ScopeRead, authUser, "Current user", (*Server).apiGetUser},
14 {http.MethodPut, "/api/v1/user", access.ScopeWrite, authUser, "Update profile language", (*Server).apiPutUser},
15 {http.MethodGet, "/api/v1/user/export", access.ScopeRead, authUser, "Export account", (*Server).apiExport},
16 {http.MethodGet, "/api/v1/users/{username}", access.ScopeRead, authUser, "User profile", (*Server).apiUserByName},
17 {http.MethodGet, "/api/v1/user/tokens", access.ScopeRead, authUser, "List access tokens", (*Server).apiListTokens},
18 {http.MethodPost, "/api/v1/user/tokens", access.ScopeWrite, authUser, "Create access token", (*Server).apiCreateToken},
19 {http.MethodDelete, "/api/v1/user/tokens/{id}", access.ScopeWrite, authUser, "Revoke access token", (*Server).apiDeleteToken},
20 {http.MethodGet, "/api/v1/user/keys", access.ScopeRead, authUser, "List SSH keys", (*Server).apiListKeys},
21 {http.MethodPost, "/api/v1/user/keys", access.ScopeWrite, authUser, "Add SSH key", (*Server).apiAddKey},
22 {http.MethodDelete, "/api/v1/user/keys/{id}", access.ScopeWrite, authUser, "Remove SSH key", (*Server).apiDeleteKey},
23
24 {http.MethodGet, "/api/v1/groups", access.ScopeRead, authUser, "List groups", (*Server).apiListGroups},
25 {http.MethodPost, "/api/v1/groups", access.ScopeWrite, authUser, "Create group", (*Server).apiCreateGroup},
26 {http.MethodGet, "/api/v1/groups/{path}", access.ScopeRead, authUser, "Get group", (*Server).apiGetGroup},
27 {http.MethodPut, "/api/v1/groups/{path}", access.ScopeWrite, authUser, "Update group", (*Server).apiPutGroup},
28 {http.MethodPost, "/api/v1/groups/{path}/transfer", access.ScopeWrite, authUser, "Transfer group owner", (*Server).apiTransferGroup},
29 {http.MethodGet, "/api/v1/groups/{path}/projects", access.ScopeRead, authUser, "List group projects", (*Server).apiGroupProjects},
30 {http.MethodGet, "/api/v1/groups/{path}/members", access.ScopeRead, authUser, "List group members", (*Server).apiGroupMembers},
31 {http.MethodPost, "/api/v1/groups/{path}/members", access.ScopeWrite, authUser, "Add group member", (*Server).apiGroupMembers},
32 {http.MethodDelete, "/api/v1/groups/{path}/members/{username}", access.ScopeWrite, authUser, "Remove group member", (*Server).apiDeleteGroupMember},
33 {http.MethodGet, "/api/v1/groups/{path}/secrets", access.ScopeRead, authUser, "List group secrets", (*Server).apiGroupSecrets},
34 {http.MethodPost, "/api/v1/groups/{path}/secrets", access.ScopeWrite, authUser, "Set group secret", (*Server).apiGroupSecrets},
35 {http.MethodDelete, "/api/v1/groups/{path}/secrets/{name}", access.ScopeWrite, authUser, "Delete group secret", (*Server).apiDeleteGroupSecret},
36 {http.MethodGet, "/api/v1/groups/{path}/webhooks", access.ScopeRead, authUser, "List group webhooks", (*Server).apiGroupHooks},
37 {http.MethodPost, "/api/v1/groups/{path}/webhooks", access.ScopeWrite, authUser, "Create group webhook", (*Server).apiGroupHooks},
38 {http.MethodDelete, "/api/v1/groups/{path}/webhooks/{id}", access.ScopeWrite, authUser, "Delete group webhook", (*Server).apiDeleteGroupHook},
39 {http.MethodGet, "/api/v1/groups/{path}/approvals", access.ScopeRead, authUser, "Get group approvals", (*Server).apiGroupApproval},
40 {http.MethodPut, "/api/v1/groups/{path}/approvals", access.ScopeWrite, authUser, "Save group approvals", (*Server).apiGroupApproval},
41 {http.MethodGet, "/api/v1/groups/{path}/logo", access.ScopeRead, authUser, "Group logo", (*Server).apiGroupLogo},
42 {http.MethodPost, "/api/v1/groups/{path}/logo", access.ScopeWrite, authUser, "Upload group logo", (*Server).apiGroupLogo},
43
44 {http.MethodGet, "/api/v1/projects", access.ScopeRead, authUser, "List projects", (*Server).apiListProjects},
45 {http.MethodPost, "/api/v1/projects", access.ScopeWrite, authUser, "Create project", (*Server).apiCreateProject},
46 {http.MethodGet, "/api/v1/projects/{owner}/{repo}", access.ScopeRepoRead, authUser, "Get project", (*Server).apiGetProject},
47 {http.MethodPut, "/api/v1/projects/{owner}/{repo}", access.ScopeWrite, authUser, "Update project", (*Server).apiPutProject},
48 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}", access.ScopeWrite, authUser, "Delete project", (*Server).apiDeleteProject},
49 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/star", access.ScopeWrite, authUser, "Toggle star", (*Server).apiStar},
50 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/logo", access.ScopeRepoRead, authUser, "Project logo", (*Server).apiProjectLogo},
51 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/logo", access.ScopeWrite, authUser, "Upload project logo", (*Server).apiProjectLogo},
52 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/members", access.ScopeRead, authUser, "List project members", (*Server).apiProjectMembers},
53 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/members", access.ScopeWrite, authUser, "Add project member", (*Server).apiProjectMembers},
54 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}/members/{username}", access.ScopeWrite, authUser, "Remove project member", (*Server).apiDeleteProjectMember},
55 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/secrets", access.ScopeRead, authUser, "List project secrets", (*Server).apiProjectSecrets},
56 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/secrets", access.ScopeWrite, authUser, "Set project secret", (*Server).apiProjectSecrets},
57 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}/secrets/{name}", access.ScopeWrite, authUser, "Delete project secret", (*Server).apiDeleteProjectSecret},
58 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/webhooks", access.ScopeRead, authUser, "List project webhooks", (*Server).apiProjectHooks},
59 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/webhooks", access.ScopeWrite, authUser, "Create project webhook", (*Server).apiProjectHooks},
60 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}/webhooks/{id}", access.ScopeWrite, authUser, "Delete project webhook", (*Server).apiDeleteProjectHook},
61 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/approvals", access.ScopeRead, authUser, "Get project approvals", (*Server).apiProjectApproval},
62 {http.MethodPut, "/api/v1/projects/{owner}/{repo}/approvals", access.ScopeWrite, authUser, "Save project approvals", (*Server).apiProjectApproval},
63 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/protected_branches", access.ScopeRead, authUser, "List protected branches", (*Server).apiProtectBranches},
64 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/protected_branches", access.ScopeWrite, authUser, "Protect branch pattern", (*Server).apiProtectBranches},
65 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}/protected_branches/{pattern...}", access.ScopeWrite, authUser, "Unprotect branch pattern", (*Server).apiUnprotectBranch},
66 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/protected_tags", access.ScopeRead, authUser, "List protected tags", (*Server).apiProtectTags},
67 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/protected_tags", access.ScopeWrite, authUser, "Protect tag pattern", (*Server).apiProtectTags},
68 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}/protected_tags/{pattern...}", access.ScopeWrite, authUser, "Unprotect tag pattern", (*Server).apiUnprotectTag},
69
70 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/branches", access.ScopeRepoRead, authUser, "List branches", (*Server).apiBranches},
71 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/repository/branches", access.ScopeRepoWrite, authUser, "Create branch", (*Server).apiBranches},
72 {http.MethodPut, "/api/v1/projects/{owner}/{repo}/repository/branches/{branch...}", access.ScopeRepoWrite, authUser, "Rename branch", (*Server).apiBranch},
73 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}/repository/branches/{branch...}", access.ScopeRepoWrite, authUser, "Delete branch", (*Server).apiBranch},
74 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/tags", access.ScopeRepoRead, authUser, "List tags", (*Server).apiTags},
75 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/repository/tags", access.ScopeRepoWrite, authUser, "Create tag", (*Server).apiTags},
76 {http.MethodDelete, "/api/v1/projects/{owner}/{repo}/repository/tags/{tag}", access.ScopeRepoWrite, authUser, "Delete tag", (*Server).apiDeleteTag},
77 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/tags/{tag}/archive", access.ScopeRepoRead, authUser, "Download tag archive", (*Server).apiTagArchive},
78 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/tree", access.ScopeRepoRead, authUser, "List tree", (*Server).apiTree},
79 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/files/{path...}", access.ScopeRepoRead, authUser, "Read file", (*Server).apiFile},
80 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/commits", access.ScopeRepoRead, authUser, "List commits", (*Server).apiCommits},
81 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/repository/commits", access.ScopeRepoWrite, authUser, "Create commit", (*Server).apiCommits},
82 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/commits/{sha}", access.ScopeRepoRead, authUser, "Get commit", (*Server).apiCommit},
83 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/repository/commits/{sha}/diff", access.ScopeRepoRead, authUser, "Commit diff", (*Server).apiCommitDiff},
84
85 {http.MethodGet, "/api/v1/repos/{owner}/{repo}/issues", access.ScopeRead, authUser, "List issues", (*Server).issuesAPI},
86 {http.MethodPost, "/api/v1/repos/{owner}/{repo}/issues", access.ScopeWrite, authUser, "Create issue", (*Server).issuesAPI},
87 {http.MethodGet, "/api/v1/repos/{owner}/{repo}/issues/{number}", access.ScopeRead, authUser, "Get issue", (*Server).issueAPI},
88 {http.MethodPut, "/api/v1/repos/{owner}/{repo}/issues/{number}", access.ScopeWrite, authUser, "Update issue", (*Server).issueAPI},
89 {http.MethodDelete, "/api/v1/repos/{owner}/{repo}/issues/{number}", access.ScopeWrite, authUser, "Delete issue", (*Server).issueAPI},
90 {http.MethodPost, "/api/v1/repos/{owner}/{repo}/issues/{number}/notes", access.ScopeWrite, authUser, "Create issue note", (*Server).issueNoteAPI},
91
92 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/merge_requests", access.ScopeRead, authUser, "List merge requests", (*Server).apiMRs},
93 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests", access.ScopeWrite, authUser, "Create merge request", (*Server).apiMRs},
94 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}", access.ScopeRead, authUser, "Get merge request", (*Server).apiMR},
95 {http.MethodPut, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}", access.ScopeWrite, authUser, "Update merge request", (*Server).apiMR},
96 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/notes", access.ScopeRead, authUser, "List notes", (*Server).apiMRNotes},
97 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/notes", access.ScopeWrite, authUser, "Create note", (*Server).apiMRNotes},
98 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/reviews", access.ScopeWrite, authUser, "Submit review", (*Server).apiReview},
99 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/reviews/dismiss", access.ScopeWrite, authUser, "Dismiss review", (*Server).apiDismissReview},
100 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/suggestions", access.ScopeRepoWrite, authUser, "Apply suggestions", (*Server).apiSuggestions},
101 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/merge", access.ScopeRepoWrite, authUser, "Merge merge request", (*Server).apiMerge},
102 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/close", access.ScopeWrite, authUser, "Close merge request", (*Server).apiCloseMR},
103 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/merge_requests/{number}/reopen", access.ScopeWrite, authUser, "Reopen merge request", (*Server).apiReopenMR},
104
105 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/pipelines", access.ScopeRead, authUser, "List pipelines", (*Server).apiPipelines},
106 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/pipelines", access.ScopeWrite, authUser, "Start pipeline", (*Server).apiPipelines},
107 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/pipelines/{id}", access.ScopeRead, authUser, "Get pipeline", (*Server).apiPipeline},
108 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/cancel", access.ScopeWrite, authUser, "Cancel pipeline", (*Server).apiCancelPipeline},
109 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs", access.ScopeRead, authUser, "List jobs", (*Server).apiJobs},
110 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}", access.ScopeRead, authUser, "Get job", (*Server).apiJob},
111 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/log", access.ScopeRead, authUser, "Job log", (*Server).apiJobLog},
112 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/play", access.ScopeWrite, authUser, "Play manual job", (*Server).apiPlayJob},
113 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/retry", access.ScopeWrite, authUser, "Retry job", (*Server).apiRetryJob},
114 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/cancel", access.ScopeWrite, authUser, "Cancel job", (*Server).apiCancelJob},
115 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/artifacts", access.ScopeRead, authUser, "List artifacts", (*Server).apiArtifacts},
116 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/artifacts/{path...}", access.ScopeRead, authUser, "Download artifact", (*Server).apiArtifact},
117
118 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/ci/file", access.ScopeRepoRead, authUser, "Read CI file", (*Server).apiCIFile},
119 {http.MethodPut, "/api/v1/projects/{owner}/{repo}/ci/file", access.ScopeRepoWrite, authUser, "Save CI file", (*Server).apiCIFile},
120 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/ci/lint", access.ScopeRead, authUser, "Lint CI file", (*Server).apiLintCI},
121 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/releases", access.ScopeRead, authUser, "List releases", (*Server).apiReleases},
122 {http.MethodPost, "/api/v1/projects/{owner}/{repo}/releases", access.ScopeWrite, authUser, "Publish release", (*Server).createRelease},
123 {http.MethodGet, "/api/v1/projects/{owner}/{repo}/releases/{tag}/assets/{name}", access.ScopeRead, authUser, "Download release asset", (*Server).apiReleaseAsset},
124 {http.MethodPost, "/api/v1/repos/{owner}/{repo}/releases", access.ScopeWrite, authRelease, "Publish release from a job or user token", (*Server).createRelease},
125
126 {http.MethodGet, "/api/v1/admin/storage", access.ScopeAdmin, authUser, "Read instance storage", (*Server).apiAdminStorage},
127 {http.MethodPut, "/api/v1/admin/storage", access.ScopeAdmin, authUser, "Set instance storage", (*Server).apiAdminStorage},
128}