Welcome to mirror list, hosted at ThFree Co, Russian Federation.

access_requests.yaml « v4 « openapi « api « doc - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 157a0973e1eb24f07efd18b794cac8873a48a97a (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
# Markdown documentation: https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/access_requests.md

#/v4/projects/{id}/access_requests
accessRequestsProjects:
  get:
    description: Lists access requests for a project
    summary: List access requests for a project
    operationId: accessRequestsProjects_get
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          oneOf:
            - type: integer
            - type: string
    responses:
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation
        content:
          application/json:
            schema:
              title: ProjectAccessResponse
              type: object
              properties:
                id:
                  type: integer
                usename:
                  type: string
                name:
                  type: string
                state:
                  type: string
                created_at:
                  type: string
                requested_at:
                  type: string
            example:
              - "id": 1
                "username": "raymond_smith"
                "name": "Raymond Smith"
                "state": "active"
                "created_at": "2012-10-22T14:13:35Z"
                "requested_at": "2012-10-22T14:13:35Z"                         
              - "id": 2
                "username": "john_doe"
                "name": "John Doe"
                "state": "active"
                "created_at": "2012-10-22T14:13:35Z"
                "requested_at": "2012-10-22T14:13:35Z"                         
  post:
    description: Requests access for the authenticated user to a project
    summary: Requests access for the authenticated user to a project
    operationId: accessRequestsProjects_post
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          oneOf:
            - type: integer
            - type: string
    responses:
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation
        content:
          application/json:
            schema:
              title: ProjectAccessRequest
              type: object
              properties:
                id:
                  type: integer
                usename:
                  type: string
                name:
                  type: string
                state:
                  type: string
                created_at:
                  type: string
                requested_at:
                  type: string
            example:
              "id": 1
              "username": "raymond_smith"
              "name": "Raymond Smith"
              "state": "active"
              "created_at": "2012-10-22T14:13:35Z"
              "requested_at": "2012-10-22T14:13:35Z"     

#/v4/projects/{id}/access_requests/{user_id}/approve
accessRequestsProjectsApprove:
  put:
    description: Approves access for the authenticated user to a project
    summary: Approves access for the authenticated user to a project
    operationId: accessRequestsProjectsApprove_put
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          oneOf:
            - type: integer
            - type: string
      - name: user_id
        in: path
        description: The userID of the access requester
        required: true
        schema:
          type: integer
      - name: access_level
        in: query
        description: A valid project access level.  0 = no access , 10 = guest, 20 = reporter, 30 = developer, 40 = Maintainer.  Default is 30.'
        required: false
        schema:
          enum: [0, 10, 20, 30, 40]
          default: 30
          type: integer
    responses:      
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation
        content:
          application/json:
            schema:
              title: ProjectAccessApprove
              type: object
              properties:
                id:
                  type: integer
                usename:
                  type: string
                name:
                  type: string
                state:
                  type: string
                created_at:
                  type: string
                access_level:
                  type: integer
            example:
              "id": 1
              "username": "raymond_smith"
              "name": "Raymond Smith"
              "state": "active"
              "created_at": "2012-10-22T14:13:35Z"
              "access_level": 20

#/v4/projects/{id}/access_requests/{user_id}
accessRequestsProjectsDeny:
  delete:
    description: Denies a project access request for the given user
    summary: Denies a project access request for the given user
    operationId: accessRequestProjectsDeny_delete
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
            oneOf:
            - type: integer
            - type: string
      - name: user_id
        in: path
        description: The user ID of the access requester
        required: true
        schema:
          type: integer
    responses:    # Does anything go here?  Markdown doc does not list a response.
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation

#/v4/groups/{id}/access_requests
accessRequestsGroups:
  get:
    description: List access requests for a group
    summary: List access requests for a group
    operationId: accessRequestsGroups_get
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          oneOf:
            - type: integer
            - type: string
    responses:
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation
        content:
          application/json:
            schema:
              title: GroupAccessResponse
              type: object
              properties:
                id:
                  type: integer
                usename:
                  type: string
                name:
                  type: string
                state:
                  type: string
                created_at:
                  type: string
                requested_at:
                  type: string
            example:
              - "id": 1
                "username": "raymond_smith"
                "name": "Raymond Smith"
                "state": "active"
                "created_at": "2012-10-22T14:13:35Z"
                "requested_at": "2012-10-22T14:13:35Z"                         
              - "id": 2
                "username": "john_doe"
                "name": "John Doe"
                "state": "active"
                "created_at": "2012-10-22T14:13:35Z"
                "requested_at": "2012-10-22T14:13:35Z"   
  post:
    description: Requests access for the authenticated user to a group
    summary: Requests access for the authenticated user to a group
    operationId: accessRequestsGroups_post
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          oneOf:
            - type: integer
            - type: string
    responses:
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation
        content:
          application/json:
            schema:
              title: GroupAccessRequest
              type: object
              properties:
                id:
                  type: integer
                usename:
                  type: string
                name:
                  type: string
                state:
                  type: string
                created_at:
                  type: string
                requested_at:
                  type: string
            example:
              "id": 1
              "username": "raymond_smith"
              "name": "Raymond Smith"
              "state": "active"
              "created_at": "2012-10-22T14:13:35Z"
              "requested_at": "2012-10-22T14:13:35Z"                         

#/v4/groups/{id}/access_requests/{user_id}/approve
accessRequestsGroupsApprove:
  put:
    description: Approves access for the authenticated user to a group
    summary: Approves access for the authenticated user to a group
    operationId: accessRequestsGroupsApprove_put
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          oneOf:
            - type: integer
            - type: string
      - name: user_id
        in: path
        description: The userID of the access requester
        required: true
        schema:
          type: integer
      - name: access_level
        in: query
        description: A valid group access level.  0 = no access , 10 = Guest, 20 = Reporter, 30 = Developer, 40 = Maintainer, 50 = Owner.  Default is 30.
        required: false
        schema:
          enum: [0, 10, 20, 30, 40, 50]
          default: 30
          type: integer
    responses:      
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation
        content:
          application/json:
            schema:
              title: GroupAccessApprove
              type: object
              properties:
                id:
                  type: integer
                usename:
                  type: string
                name:
                  type: string
                state:
                  type: string
                created_at:
                  type: string
                access_level:
                  type: integer
            example:
              "id": 1
              "username": "raymond_smith"
              "name": "Raymond Smith"
              "state": "active"
              "created_at": "2012-10-22T14:13:35Z"
              "access_level": 20   

#/v4/groups/{id}/access_requests/{user_id}
accessRequestsGroupsDeny:
  delete:
    description: Denies a group access request for the given user
    summary: Denies a group access request for the given user
    operationId: accessRequestsGroupsDeny_delete
    tags:
      - access_requests
    parameters:
      - name: id
        in: path
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
            oneOf:
            - type: integer
            - type: string
      - name: user_id
        in: path
        description: The userID of the access requester
        required: true
        schema:
          type: integer
    responses:    # Does anything go here?  Markdown doc does not list a response.
      '401':
        description: Unauthorized operation
      '200':
        description: Successful operation