aboutsummaryrefslogtreecommitdiff
path: root/docs/api.yaml
blob: 3e79f0b5c34aadb31f02d23afd524be140fa8bbf (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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
swagger: '2.0'
info:
  title: Patchwork API
  description: |
    Patchwork is a web-based patch tracking system designed to facilitate the
    contribution and management of contributions to an open-source project.
  version: "1.0"
host: patchwork.ozlabs.org
schemes:
  - http
  - https
securityDefinitions:
  basicAuth:
    type: basic
    description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
basePath: /api/1.0
produces:
  - application/json
paths:
  /:
    get:
      summary: API metadata.
      description: |
        The Metadata endpoint returns information about the API itself.
        The response includes the version of the API.
      responses:
        200:
          description: An API metadata object.
          schema:
            $ref: '#/definitions/Metadata'
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /projects:
    get:
      summary: List available projects.
      description: |
        Returns information about all projects available on this patchwork
        instance.
      parameters:
        - $ref: '#/parameters/perPageParam'
        - $ref: '#/parameters/pageParam'
      tags:
        - Projects
      responses:
        200:
          description: An array of projects objects.
          schema:
            type: array
            items:
              $ref: '#/definitions/Project'
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /projects/{projectId}:
    get:
      summary: Retrieve a project.
      description: |
        Returns information about a single project available on this patchwork
        instance.
      parameters:
        - $ref: '#/parameters/projectId'
      tags:
        - Projects
      responses:
        200:
          description: A project object.
          schema:
            $ref: '#/definitions/Project'
        404:
          description: The project does not exist
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    patch:
      summary: Update a project.
      description: |
        Update information about a single project available on this patchwork
        instance.
      parameters:
        - $ref: '#/parameters/projectId'
      tags:
        - Projects
      security:
       - basicAuth: []
      responses:
        200:
          description: A project object.
          schema:
            $ref: '#/definitions/Project'
        403:
          description: The user is not authenticated or is not a superuser.
        404:
          description: The project does not exist.
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /people:
    get:
      summary: List available people.
      description: |
        Returns information about all people who have submitted patches on this
        patchwork instance.
      parameters:
        - $ref: '#/parameters/perPageParam'
        - $ref: '#/parameters/pageParam'
      tags:
        - People
      responses:
        200:
          description: An array of people objects.
          schema:
            type: array
            items:
              $ref: '#/definitions/People'
        403:
          description: The user is not authenticated.
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /people/{personId}:
    get:
      summary: Retrieve a person.
      description: |
        Returns information about a single person who has submitted patches on
        this patchwork instance.
      parameters:
        - $ref: '#/parameters/personId'
      tags:
        - People
      responses:
        200:
          description: A person object.
          schema:
            $ref: '#/definitions/People'
        403:
          description: The user is not authenticated.
        404:
          description: The person does not exist.
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /users:
    get:
      summary: List available users.
      description: |
        Returns information about all users registerd on this Patchwork
        instance.
      parameters:
        - $ref: '#/parameters/perPageParam'
        - $ref: '#/parameters/pageParam'
      tags:
        - Users
      security:
       - basicAuth: []
      responses:
        200:
          description: An array of user objects.
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /users/{userId}:
    get:
      summary: Retrieve a user.
      description: |
        Returns information about a single user registerd on this Patchwork
        instance.
      parameters:
        - $ref: '#/parameters/userId'
      tags:
        - Users
      security:
       - basicAuth: []
      responses:
        200:
          description: A user object.
          schema:
            $ref: '#/definitions/User'
        403:
          description: The user is not authenticated.
        404:
          description: The user does not exists.
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/User'
  /patches:
    get:
      summary: List available patches
      description: |
        Returns information about all patches available on this patchwork
        instance.
      parameters:
        - $ref: '#/parameters/perPageParam'
        - $ref: '#/parameters/pageParam'
        - $ref: '#/parameters/sinceParam'
        - $ref: '#/parameters/untilParam'
      tags:
        - Patches
      responses:
        200:
          description: An array of patch objects.
          schema:
            type: array
            items:
              $ref: '#/definitions/Patch'
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /patches/{patchId}:
    get:
      summary: Retrieve a patch.
      description: |
        Returns information about a single patch available on this patchwork
        instance.
      parameters:
        - $ref: '#/parameters/patchId'
      tags:
        - Patches
      responses:
        200:
          description: A patch object.
          schema:
            $ref: '#/definitions/PatchDetail'
        404:
          description: The patch does not exist
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    patch:
      summary: Update a patch.
      description: |
        Update information about a patch.
      parameters:
        - $ref: '#/parameters/patchId'
      tags:
        - Patches
      security:
       - basicAuth: []
      responses:
        200:
          description: A patch object.
          schema:
            $ref: '#/definitions/PatchDetail'
        403:
          description: |
            The user is not authenticated, or the user did not create the
            patch and is not a super user.
        404:
          description: The patch does not exist
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /patches/{patchId}/checks:
    get:
      summary: List checks for given patch.
      description: |
        Checks store the results of any tests executed (or executing) for a
        given patch. This is useful, for example, when using a continuous
        integration (CI) system to test patches.
      parameters:
        - $ref: '#/parameters/patchId'
        - $ref: '#/parameters/perPageParam'
        - $ref: '#/parameters/pageParam'
      tags:
        - Checks
      responses:
        200:
          description: A check object.
          schema:
            $ref: '#/definitions/Check'
        404:
          description: The parent patch does not exist
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  # TODO(stephenfin): Document creation of checks, listing of users
parameters:
  # ID Parameters
  projectId:
    name: projectId
    description: ID of project that needs to be retrieved.
    in: path
    type: integer
    format: int32
    required: true
  personId:
    name: personId
    description: ID of person that needs to be retrieved.
    in: path
    type: integer
    format: int32
    required: true
  userId:
    name: userId
    description: ID of a user.
    in: path
    type: integer
    format: int32
    required: true
  patchId:
    name: patchId
    description: |
      ID of patch that needs to be retrieved. This should be one of: a patch
      ID, a patch hash, a Message-ID.
    in: path
    type: string
    required: true
  # Generic parameters
  pageParam:
    name: page
    description: page to retrieve
    in: query
    type: integer
    format: int32
    minimum: 1
    default: 1
  perPageParam:
    name: per_page
    description: custom page size
    in: query
    type: integer
    format: int32
    minimum: 0
    maximum: 100
    default: 30
  sinceParam:
    name: since
    description: only items modified after this date will be returned
    in: query
    type: string
    format: date
  untilParam:
    name: until
    description: only items modified before this date will be returned
    in: query
    type: string
    format: date
definitions:
  Metadata:
    properties:
      revision:
        type: integer
        description: Revision of the API.
  Project:
    properties:
      id:
        type: integer
        description: Unique identifier of project.
      url:
        type: string
        description: url to project.
      name:
        type: string
        description: Name of project.
      link_name:
        type: string
        description: Link name of project.
      list_id:
        type: string
        description: Mailing list identifier for project.
      list_email:
        type: string
        description: Mailing list email address for project.
      web_url:
        type: string
        description: Upstream website URL for project.
      scm_url:
        type: string
        description: SCM clone URL for project.
      webscm_url:
        type: string
        description: SCM web interface URL for project.
  Patch:
    properties:
      id:
        type: integer
        description: Unique identifier of patch.
      url:
        type: string
        description: URL to patch.
      project:
        type: string
        description: URL to patch's project.
      msgid:
        type: string
        description: Message ID header from patch mail.
      date:
        type: string
        format: date-time
        description: Submission date of patch.
      name:
        type: string
        description: Name of patch.
      commit_ref:
        type: string
        description: Ref of committed patch.
      pull_url:
        type: string
        description: URL to patch pull request.
      state:
        type: string
        description: The state of the patch.
      archived:
        type: boolean
        description: Archival state of patch.
      hash:
        type: string
        description: Hash of patch's diff.
      submitter:
        type: string
        description: URL for submitter of patch.
      delegate:
        type: integer
        description: URL for delegate assigned to patch.
      mbox:
        type: string
        description: Link to the raw patch mbox contents.
      check:
        type: string
        description: The combined check status for the patch.
        enum:
          - pending
          - success
          - warning
          - fail
      checks:
        type: string
        description: URL to patch's checks endpoint.
      tags:
        type: array
        description: Tags associated with patch.
        items:
          type: string
  PatchDetail:
    allOf:
      - $ref: '#/definitions/Patch'
    properties:
      diff:
        type: string
        description: Diff of patch.
      content:
        type: string
        description: Message of patch.
      headers:
        type: array
        description: The headers of the patch.
        items:
          type: string
  People:
    properties:
      id:
        type: integer
        description: Unique identifier of person.
      url:
        type: string
        description: URL to person.
      name:
        type: string
        description: Name of person.
      email:
        type: string
        description: Email of person.
      user:
        type: string
        description: URL for user connected to person.
  Check:
    properties:
      id:
        type: integer
        description: Unique identifier of check.
      url:
        type: string
        description: URL to check.
      user:
        type: string
        description: URL for creator of check.
      date:
        type: string
        format: date-time
      state:
        type: string
        description: The state of the check.
        enum:
          - pending
          - success
          - warning
          - fail
      target_url:
        type: string
        description: The target URL associated with this check.
      context:
        type: string
        description: |
          A label to discern check from checks of other testing systems.
      description:
        type: string
        description: A brief description of the check.
  User:
    properties:
      id:
        type: integer
        description: Unique identifier of user.
      url:
        type: string
        description: URL to user.
      username:
        type: string
        description: Username of user.
      first_name:
        type: string
        description: First name of user.
      last_name:
        type: string
        description: Last name of user.
      email:
        type: string
        description: Email of user.
  Error:
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      fields:
        type: string