Skip to content

Commit 3bd8b7d

Browse files
AlexMaryWAlexMaryW
committed
Improve owner parameter description in affected endpoints
1 parent d084598 commit 3bd8b7d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+263
-263
lines changed

‎routers/api/v1/admin/adopt.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ func AdoptRepository(ctx *context.APIContext) {
6565
// parameters:
6666
// - name: owner
6767
// in: path
68-
// description: owner of the repo
68+
// description: username of the user or organization owning the repository
6969
// type: string
7070
// required: true
7171
// - name: repo
@@ -129,7 +129,7 @@ func DeleteUnadoptedRepository(ctx *context.APIContext) {
129129
// parameters:
130130
// - name: owner
131131
// in: path
132-
// description: owner of the repo
132+
// description: username of the user or organization owning the repository
133133
// type: string
134134
// required: true
135135
// - name: repo

‎routers/api/v1/misc/signing.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func SigningKeyGPG(ctx *context.APIContext) {
5252
// parameters:
5353
// - name: owner
5454
// in: path
55-
// description: owner of the repo
55+
// description: username of the user or organization owning the repository
5656
// type: string
5757
// required: true
5858
// - name: repo
@@ -89,7 +89,7 @@ func SigningKeySSH(ctx *context.APIContext) {
8989
// parameters:
9090
// - name: owner
9191
// in: path
92-
// description: owner of the repo
92+
// description: username of the user or organization owning the repository
9393
// type: string
9494
// required: true
9595
// - name: repo

‎routers/api/v1/notify/repo.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func ListRepoNotifications(ctx *context.APIContext) {
5454
// parameters:
5555
// - name: owner
5656
// in: path
57-
// description: owner of the repo
57+
// description: username of the user or organization owning the repository
5858
// type: string
5959
// required: true
6060
// - name: repo
@@ -142,7 +142,7 @@ func ReadRepoNotifications(ctx *context.APIContext) {
142142
// parameters:
143143
// - name: owner
144144
// in: path
145-
// description: owner of the repo
145+
// description: username of the user or organization owning the repository
146146
// type: string
147147
// required: true
148148
// - name: repo

‎routers/api/v1/packages/package.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func ListPackages(ctx *context.APIContext) {
2828
// parameters:
2929
// - name: owner
3030
// in: path
31-
// description: owner of the packages
31+
// description: username of the user or organization owning the packages
3232
// type: string
3333
// required: true
3434
// - name: page
@@ -83,7 +83,7 @@ func GetPackage(ctx *context.APIContext) {
8383
// parameters:
8484
// - name: owner
8585
// in: path
86-
// description: owner of the package
86+
// description: username of the user or organization owning the package
8787
// type: string
8888
// required: true
8989
// - name: type
@@ -124,7 +124,7 @@ func DeletePackage(ctx *context.APIContext) {
124124
// parameters:
125125
// - name: owner
126126
// in: path
127-
// description: owner of the package
127+
// description: username of the user or organization owning the package
128128
// type: string
129129
// required: true
130130
// - name: type
@@ -166,7 +166,7 @@ func ListPackageFiles(ctx *context.APIContext) {
166166
// parameters:
167167
// - name: owner
168168
// in: path
169-
// description: owner of the package
169+
// description: username of the user or organization owning the package
170170
// type: string
171171
// required: true
172172
// - name: type
@@ -208,7 +208,7 @@ func ListPackageVersions(ctx *context.APIContext) {
208208
// parameters:
209209
// - name: owner
210210
// in: path
211-
// description: owner of the package
211+
// description: username of the user or organization owning the package
212212
// type: string
213213
// required: true
214214
// - name: type
@@ -264,7 +264,7 @@ func GetLatestPackageVersion(ctx *context.APIContext) {
264264
// parameters:
265265
// - name: owner
266266
// in: path
267-
// description: owner of the package
267+
// description: username of the user or organization owning the package
268268
// type: string
269269
// required: true
270270
// - name: type
@@ -321,7 +321,7 @@ func LinkPackage(ctx *context.APIContext) {
321321
// parameters:
322322
// - name: owner
323323
// in: path
324-
// description: owner of the package
324+
// description: username of the user or organization owning the package
325325
// type: string
326326
// required: true
327327
// - name: type
@@ -388,7 +388,7 @@ func UnlinkPackage(ctx *context.APIContext) {
388388
// parameters:
389389
// - name: owner
390390
// in: path
391-
// description: owner of the package
391+
// description: username of the user or organization owning the package
392392
// type: string
393393
// required: true
394394
// - name: type

‎routers/api/v1/repo/action.go

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func (Action) ListActionsSecrets(ctx *context.APIContext) {
4646
// parameters:
4747
// - name: owner
4848
// in: path
49-
// description: owner of the repository
49+
// description: username of the user or organization owning the repository
5050
// type: string
5151
// required: true
5252
// - name: repo
@@ -106,7 +106,7 @@ func (Action) CreateOrUpdateSecret(ctx *context.APIContext) {
106106
// parameters:
107107
// - name: owner
108108
// in: path
109-
// description: owner of the repository
109+
// description: username of the user or organization owning the repository
110110
// type: string
111111
// required: true
112112
// - name: repo
@@ -168,7 +168,7 @@ func (Action) DeleteSecret(ctx *context.APIContext) {
168168
// parameters:
169169
// - name: owner
170170
// in: path
171-
// description: owner of the repository
171+
// description: username of the user or organization owning the repository
172172
// type: string
173173
// required: true
174174
// - name: repo
@@ -216,7 +216,7 @@ func (Action) GetVariable(ctx *context.APIContext) {
216216
// parameters:
217217
// - name: owner
218218
// in: path
219-
// description: name of the owner
219+
// description: username of the user or organization owning the repository
220220
// type: string
221221
// required: true
222222
// - name: repo
@@ -270,7 +270,7 @@ func (Action) DeleteVariable(ctx *context.APIContext) {
270270
// parameters:
271271
// - name: owner
272272
// in: path
273-
// description: name of the owner
273+
// description: username of the user or organization owning the repository
274274
// type: string
275275
// required: true
276276
// - name: repo
@@ -319,7 +319,7 @@ func (Action) CreateVariable(ctx *context.APIContext) {
319319
// parameters:
320320
// - name: owner
321321
// in: path
322-
// description: name of the owner
322+
// description: username of the user or organization owning the repository
323323
// type: string
324324
// required: true
325325
// - name: repo
@@ -386,7 +386,7 @@ func (Action) UpdateVariable(ctx *context.APIContext) {
386386
// parameters:
387387
// - name: owner
388388
// in: path
389-
// description: name of the owner
389+
// description: username of the user or organization owning the repository
390390
// type: string
391391
// required: true
392392
// - name: repo
@@ -458,7 +458,7 @@ func (Action) ListVariables(ctx *context.APIContext) {
458458
// parameters:
459459
// - name: owner
460460
// in: path
461-
// description: name of the owner
461+
// description: username of the user or organization owning the repository
462462
// type: string
463463
// required: true
464464
// - name: repo
@@ -516,7 +516,7 @@ func (Action) GetRegistrationToken(ctx *context.APIContext) {
516516
// parameters:
517517
// - name: owner
518518
// in: path
519-
// description: owner of the repo
519+
// description: username of the user or organization owning the repository
520520
// type: string
521521
// required: true
522522
// - name: repo
@@ -541,7 +541,7 @@ func (Action) CreateRegistrationToken(ctx *context.APIContext) {
541541
// parameters:
542542
// - name: owner
543543
// in: path
544-
// description: owner of the repo
544+
// description: username of the user or organization owning the repository
545545
// type: string
546546
// required: true
547547
// - name: repo
@@ -566,7 +566,7 @@ func (Action) ListRunners(ctx *context.APIContext) {
566566
// parameters:
567567
// - name: owner
568568
// in: path
569-
// description: owner of the repo
569+
// description: username of the user or organization owning the repository
570570
// type: string
571571
// required: true
572572
// - name: repo
@@ -594,7 +594,7 @@ func (Action) GetRunner(ctx *context.APIContext) {
594594
// parameters:
595595
// - name: owner
596596
// in: path
597-
// description: owner of the repo
597+
// description: username of the user or organization owning the repository
598598
// type: string
599599
// required: true
600600
// - name: repo
@@ -627,7 +627,7 @@ func (Action) DeleteRunner(ctx *context.APIContext) {
627627
// parameters:
628628
// - name: owner
629629
// in: path
630-
// description: owner of the repo
630+
// description: username of the user or organization owning the repository
631631
// type: string
632632
// required: true
633633
// - name: repo
@@ -778,7 +778,7 @@ func ListActionTasks(ctx *context.APIContext) {
778778
// parameters:
779779
// - name: owner
780780
// in: path
781-
// description: owner of the repo
781+
// description: username of the user or organization owning the repository
782782
// type: string
783783
// required: true
784784
// - name: repo
@@ -842,7 +842,7 @@ func ActionsListRepositoryWorkflows(ctx *context.APIContext) {
842842
// parameters:
843843
// - name: owner
844844
// in: path
845-
// description: owner of the repo
845+
// description: username of the user or organization owning the repository
846846
// type: string
847847
// required: true
848848
// - name: repo
@@ -882,7 +882,7 @@ func ActionsGetWorkflow(ctx *context.APIContext) {
882882
// parameters:
883883
// - name: owner
884884
// in: path
885-
// description: owner of the repo
885+
// description: username of the user or organization owning the repository
886886
// type: string
887887
// required: true
888888
// - name: repo
@@ -932,7 +932,7 @@ func ActionsDisableWorkflow(ctx *context.APIContext) {
932932
// parameters:
933933
// - name: owner
934934
// in: path
935-
// description: owner of the repo
935+
// description: username of the user or organization owning the repository
936936
// type: string
937937
// required: true
938938
// - name: repo
@@ -980,7 +980,7 @@ func ActionsDispatchWorkflow(ctx *context.APIContext) {
980980
// parameters:
981981
// - name: owner
982982
// in: path
983-
// description: owner of the repo
983+
// description: username of the user or organization owning the repository
984984
// type: string
985985
// required: true
986986
// - name: repo
@@ -1059,7 +1059,7 @@ func ActionsEnableWorkflow(ctx *context.APIContext) {
10591059
// parameters:
10601060
// - name: owner
10611061
// in: path
1062-
// description: owner of the repo
1062+
// description: username of the user or organization owning the repository
10631063
// type: string
10641064
// required: true
10651065
// - name: repo
@@ -1261,7 +1261,7 @@ func GetArtifactsOfRun(ctx *context.APIContext) {
12611261
// parameters:
12621262
// - name: owner
12631263
// in: path
1264-
// description: name of the owner
1264+
// description: username of the user or organization owning the repository
12651265
// type: string
12661266
// required: true
12671267
// - name: repo
@@ -1330,7 +1330,7 @@ func DeleteActionRun(ctx *context.APIContext) {
13301330
// parameters:
13311331
// - name: owner
13321332
// in: path
1333-
// description: name of the owner
1333+
// description: username of the user or organization owning the repository
13341334
// type: string
13351335
// required: true
13361336
// - name: repo
@@ -1382,7 +1382,7 @@ func GetArtifacts(ctx *context.APIContext) {
13821382
// parameters:
13831383
// - name: owner
13841384
// in: path
1385-
// description: name of the owner
1385+
// description: username of the user or organization owning the repository
13861386
// type: string
13871387
// required: true
13881388
// - name: repo
@@ -1443,7 +1443,7 @@ func GetArtifact(ctx *context.APIContext) {
14431443
// parameters:
14441444
// - name: owner
14451445
// in: path
1446-
// description: name of the owner
1446+
// description: username of the user or organization owning the repository
14471447
// type: string
14481448
// required: true
14491449
// - name: repo
@@ -1492,7 +1492,7 @@ func DeleteArtifact(ctx *context.APIContext) {
14921492
// parameters:
14931493
// - name: owner
14941494
// in: path
1495-
// description: name of the owner
1495+
// description: username of the user or organization owning the repository
14961496
// type: string
14971497
// required: true
14981498
// - name: repo
@@ -1559,7 +1559,7 @@ func DownloadArtifact(ctx *context.APIContext) {
15591559
// parameters:
15601560
// - name: owner
15611561
// in: path
1562-
// description: name of the owner
1562+
// description: username of the user or organization owning the repository
15631563
// type: string
15641564
// required: true
15651565
// - name: repo

‎routers/api/v1/repo/actions_run.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func DownloadActionsRunJobLogs(ctx *context.APIContext) {
2121
// parameters:
2222
// - name: owner
2323
// in: path
24-
// description: name of the owner
24+
// description: username of the user or organization owning the repository
2525
// type: string
2626
// required: true
2727
// - name: repo

‎routers/api/v1/repo/avatar.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ func UpdateAvatar(ctx *context.APIContext) {
2323
// parameters:
2424
// - name: owner
2525
// in: path
26-
// description: owner of the repo
26+
// description: username of the user or organization owning the repository
2727
// type: string
2828
// required: true
2929
// - name: repo
@@ -66,7 +66,7 @@ func DeleteAvatar(ctx *context.APIContext) {
6666
// parameters:
6767
// - name: owner
6868
// in: path
69-
// description: owner of the repo
69+
// description: username of the user or organization owning the repository
7070
// type: string
7171
// required: true
7272
// - name: repo

‎routers/api/v1/repo/blob.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ func GetBlob(ctx *context.APIContext) {
2020
// parameters:
2121
// - name: owner
2222
// in: path
23-
// description: owner of the repo
23+
// description: username of the user or organization owning the repository
2424
// type: string
2525
// required: true
2626
// - name: repo

0 commit comments

Comments
 (0)