blob: 5a99f6c8793fb0a878985dcf8de61aff0e67e833 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
|
---
info:
title: GitLab API
version: v4
swagger: '2.0'
produces:
- application/json
securityDefinitions:
access_token_header:
type: apiKey
name: PRIVATE-TOKEN
in: header
access_token_query:
type: apiKey
name: private_token
in: query
host: gitlab.com
tags:
- name: user_counts
description: Operations about user_counts
- name: metadata
description: Operations related to metadata of the GitLab instance
- name: access_requests
description: Operations related to access requests
paths:
"/api/v4/groups/{id}/access_requests/{user_id}":
delete:
summary: Denies an access request for the given user.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated
user
type: string
required: true
- in: path
name: user_id
description: The user ID of the access requester
type: integer
format: int32
required: true
responses:
'204':
description: Denies an access request for the given user.
tags:
- access_requests
operationId: deleteApiV4GroupsIdAccessRequestsUserId
"/api/v4/groups/{id}/access_requests/{user_id}/approve":
put:
summary: Approves an access request for the given user.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated
user
type: string
required: true
- in: path
name: user_id
description: The user ID of the access requester
type: integer
format: int32
required: true
- in: formData
name: access_level
description: 'A valid access level (defaults: `30`, the Developer role)'
type: integer
format: int32
default: 30
required: false
responses:
'200':
description: successful operation
schema:
"$ref": "#/definitions/API_Entities_AccessRequester"
examples:
successfull_response:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: '2012-10-22T14:13:35Z'
access_level: 20
tags:
- access_requests
operationId: putApiV4GroupsIdAccessRequestsUserIdApprove
"/api/v4/groups/{id}/access_requests":
post:
summary: Requests access for the authenticated user to a group.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated
user
type: string
required: true
responses:
'200':
description: successful operation
schema:
"$ref": "#/definitions/API_Entities_AccessRequester"
examples:
successfull_response:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: '2012-10-22T14:13:35Z'
access_level: 20
tags:
- access_requests
operationId: postApiV4GroupsIdAccessRequests
get:
summary: Gets a list of access requests for a group.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated
user
type: string
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
responses:
'200':
description: Gets a list of access requests for a group.
schema:
"$ref": "#/definitions/API_Entities_AccessRequester"
tags:
- access_requests
operationId: getApiV4GroupsIdAccessRequests
"/api/v4/projects/{id}/access_requests/{user_id}":
delete:
summary: Denies an access request for the given user.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated
user
type: string
required: true
- in: path
name: user_id
description: The user ID of the access requester
type: integer
format: int32
required: true
responses:
'204':
description: Denies an access request for the given user.
tags:
- access_requests
operationId: deleteApiV4ProjectsIdAccessRequestsUserId
"/api/v4/projects/{id}/access_requests/{user_id}/approve":
put:
summary: Approves an access request for the given user.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated
user
type: string
required: true
- in: path
name: user_id
description: The user ID of the access requester
type: integer
format: int32
required: true
- in: formData
name: access_level
description: 'A valid access level (defaults: `30`, the Developer role)'
type: integer
format: int32
default: 30
required: false
responses:
'200':
description: successful operation
schema:
"$ref": "#/definitions/API_Entities_AccessRequester"
examples:
successfull_response:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: '2012-10-22T14:13:35Z'
access_level: 20
tags:
- access_requests
operationId: putApiV4ProjectsIdAccessRequestsUserIdApprove
"/api/v4/projects/{id}/access_requests":
post:
summary: Requests access for the authenticated user to a project.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated
user
type: string
required: true
responses:
'200':
description: successful operation
schema:
"$ref": "#/definitions/API_Entities_AccessRequester"
examples:
successfull_response:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: '2012-10-22T14:13:35Z'
access_level: 20
tags:
- access_requests
operationId: postApiV4ProjectsIdAccessRequests
get:
summary: Gets a list of access requests for a project.
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated
user
type: string
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
responses:
'200':
description: Gets a list of access requests for a project.
schema:
"$ref": "#/definitions/API_Entities_AccessRequester"
tags:
- access_requests
operationId: getApiV4ProjectsIdAccessRequests
"/api/v4/user_counts":
get:
summary: Return the user specific counts
description: Assigned open issues, assigned MRs and pending todos count
produces:
- application/json
responses:
'200':
description: Return the user specific counts
schema:
"$ref": "#/definitions/API_Entities_UserCounts"
tags:
- user_counts
operationId: getApiV4UserCounts
"/api/v4/metadata":
get:
summary: Retrieve metadata information for this GitLab instance.
description: This feature was introduced in GitLab 15.2.
produces:
- application/json
responses:
'200':
description: successful operation
schema:
"$ref": "#/definitions/API_Entities_Metadata"
examples:
successful_response:
value:
version: 15.0-pre
revision: c401a659d0c
kas:
enabled: true
externalUrl: grpc://gitlab.example.com:8150
version: 15.0.0
'401':
description: unauthorized operation
tags:
- metadata
operationId: getApiV4Metadata
"/api/v4/version":
get:
summary: Get the version information of the GitLab instance.
description: This feature was introduced in GitLab 8.13 and deprecated in 15.5.
We recommend you instead use the Metadata API.
produces:
- application/json
responses:
'200':
description: successful operation
schema:
"$ref": "#/definitions/API_Entities_Metadata"
examples:
Example:
value:
version: 15.0-pre
revision: c401a659d0c
kas:
enabled: true
externalUrl: grpc://gitlab.example.com:8150
version: 15.0.0
'401':
description: unauthorized operation
tags:
- metadata
operationId: getApiV4Version
definitions:
API_Entities_AccessRequester:
type: object
properties:
id:
type: string
username:
type: string
name:
type: string
state:
type: string
avatar_url:
type: string
avatar_path:
type: string
custom_attributes:
"$ref": "#/definitions/API_Entities_CustomAttribute"
web_url:
type: string
is_gitlab_employee:
type: string
email:
type: string
requested_at:
type: string
description: API_Entities_AccessRequester model
API_Entities_CustomAttribute:
type: object
properties:
key:
type: string
value:
type: string
API_Entities_UserCounts:
type: object
properties:
merge_requests:
type: integer
format: int32
example: 10
assigned_issues:
type: integer
format: int32
example: 10
assigned_merge_requests:
type: integer
format: int32
example: 10
review_requested_merge_requests:
type: integer
format: int32
example: 10
todos:
type: integer
format: int32
example: 10
description: API_Entities_UserCounts model
API_Entities_Metadata:
type: object
properties:
version:
type: string
revision:
type: string
kas:
type: object
properties:
enabled:
type: boolean
externalUrl:
type: string
version:
type: string
description: API_Entities_Metadata model
|
