Tested using 'yamllint'.
Signed-off-by: Stephen Finucane <stephen@that.guru>
with open(os.path.join(version_dir, 'patchwork.yaml'), 'wb') as fh:
template.stream(version=version, version_str=version_str,
version_url=version_url).dump(fh, encoding='utf-8')
+ fh.write('\n')
if __name__ == '__main__':
# DO NOT EDIT THIS FILE. It is generated from a template. Changes should be
# proposed against the template.
+---
openapi: '3.0.0'
info:
title: Patchwork API
- description: |
+ description: >
Patchwork is a web-based patch tracking system designed to facilitate the
contribution and management of contributions to an open-source project.
contact:
schema:
$ref: '#/components/schemas/Index'
tags:
- - api
+ - api
/api/bundles/:
get:
description: List bundles.
operationId: bundles_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: owner
- description: 'An ID or username of a user to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: public
- description: 'Show only public (`true`) or private (`false`) bundles.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: owner
+ description: An ID or username of a user to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: public
+ description: Show only public (`true`) or private (`false`) bundles.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Bundle'
tags:
- - bundles
+ - bundles
/api/bundles/{id}/:
get:
description: Show a bundle.
operationId: bundles_read
parameters:
- - in: path
- name: id
- required: true
- description: 'A unique integer value identifying this bundle.'
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ required: true
+ description: A unique integer value identifying this bundle.
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Bundle'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - bundles
+ - bundles
/api/covers/:
get:
description: List cover letters.
operationId: covers_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter cover letters by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: >
+ An ID or linkname of a project to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter cover letters by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/CoverLetterList'
tags:
- - covers
+ - covers
/api/covers/{id}/:
get:
description: Show a cover letter.
operationId: covers_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this cover letter.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/CoverLetterDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - covers
+ - covers
/api/covers/{id}/comments/:
get:
description: List comments
operationId: cover_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent cover letter.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: >
+ A unique integer value identifying the parent cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/events/:
get:
description: List events.
operationId: events_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter events by.'
- schema:
- title: ''
- type: string
- - in: query
- name: category
- description: 'An event category to filter events by.'
- schema:
- title: ''
- type: string
- enum:
- - cover-created
- - patch-created
- - patch-completed
- - patch-state-changed
- - patch-delegated
- - check-created
- - series-created
- - series-completed
- - in: query
- name: series
- description: 'An ID of a series to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: patch
- description: 'An ID of a patch to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: cover
- description: 'An ID of a cover letter to filter events by.'
- schema:
- title: ''
- type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter events by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: category
+ description: An event category to filter events by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - cover-created
+ - patch-created
+ - patch-completed
+ - patch-state-changed
+ - patch-delegated
+ - check-created
+ - series-created
+ - series-completed
+ - in: query
+ name: series
+ description: An ID of a series to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: patch
+ description: An ID of a patch to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: cover
+ description: An ID of a cover letter to filter events by.
+ schema:
+ title: ''
+ type: integer
responses:
'200':
description: ''
mapping:
cover-created: '#/components/schemas/EventCoverCreated'
patch-created: '#/components/schemas/EventPatchCreated'
- patch-completed: '#/components/schemas/EventPatchCompleted'
- patch-state-changed: '#/components/schemas/EventPatchStateChanged'
- patch-delegated: '#/components/schemas/EventPatchDelegated'
+ patch-completed: >
+ '#/components/schemas/EventPatchCompleted'
+ patch-state-changed: >
+ '#/components/schemas/EventPatchStateChanged'
+ patch-delegated: >
+ '#/components/schemas/EventPatchDelegated'
check-created: '#/components/schemas/EventCheckCreated'
series-created: '#/components/schemas/EventSeriesCreated'
- series-completed: '#/components/schemas/EventSeriesCompleted'
+ series-completed: >
+ '#/components/schemas/EventSeriesCompleted'
tags:
- - events
+ - events
/api/patches/:
get:
description: List patches.
operationId: patches_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter patches by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: delegate
- description: 'An ID or username of a user to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A slug representation of a state to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: archived
- description: 'Show only archived (`true`) or non-archived (`false`) patches.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter patches by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: delegate
+ description: An ID or username of a user to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A slug representation of a state to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: archived
+ description: >
+ Show only archived (`true`) or non-archived (`false`) patches.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/PatchList'
tags:
- - patches
+ - patches
/api/patches/{id}/:
get:
description: Show a patch.
operationId: patches_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/PatchDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
patch:
description: Update a patch (partial).
operationId: patches_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
put:
description: Update a patch.
operationId: patches_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
/api/patches/{id}/comments/:
get:
description: List comments
operationId: patch_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/patches/{patch_id}/checks/:
get:
description: List checks.
operationId: checks_list
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: user
- description: 'An ID or username of a user to filter checks by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A check state to filter checks by.'
- schema:
- title: ''
- type: string
- enum:
- - pending
- - success
- - warning
- - fail
- - in: query
- name: context
- description: 'A check context to filter checks by.'
- schema:
- title: ''
- type: string
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: user
+ description: An ID or username of a user to filter checks by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A check state to filter checks by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
+ - in: query
+ name: context
+ description: A check context to filter checks by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
post:
description: Create a check.
operationId: checks_create
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
schema:
$ref: '#/components/schemas/Check'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorCheckCreate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/patches/{patch_id}/checks/{check_id}/:
get:
description: Show a check.
operationId: checks_read
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - in: path
- name: check_id
- description: 'A unique integer value identifying this check.'
- required: true
- schema:
- title: Check ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - in: path
+ name: check_id
+ description: A unique integer value identifying this check.
+ required: true
+ schema:
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/people/:
get:
description: List people.
operationId: people_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/people/{id}/:
get:
description: Show a person.
operationId: people_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this person.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this person.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/projects/:
get:
description: List projects.
operationId: projects_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Project'
tags:
- - projects
+ - projects
/api/projects/{id}/:
get:
description: Show a project.
operationId: projects_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Project'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
patch:
description: Update a project (partial).
operationId: projects_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
put:
description: Update a project.
operationId: projects_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
/api/series/:
get:
description: List series.
operationId: series_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter series by.'
- schema:
- title: ''
- type: string
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter series by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: submitter
+ description: An ID or email address of a person to filter series by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter series by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Series'
tags:
- - series
+ - series
/api/series/{id}/:
get:
description: Show a series.
operationId: series_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this series.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this series.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Series'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - series
+ - series
/api/users/:
get:
description: List users.
operationId: users_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
/api/users/{id}/:
get:
description: Show a user.
operationId: users_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
patch:
description: Update a user (partial).
operationId: users_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
put:
description: Update a user.
operationId: users_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
components:
securitySchemes:
basicAuth:
Page:
in: query
name: page
- description: 'A page number within the paginated result set.'
+ description: A page number within the paginated result set.
schema:
title: Page
type: integer
PageSize:
in: query
name: per_page
- description: 'Number of results to return per page.'
+ description: Number of results to return per page.
schema:
title: Page size
type: integer
Order:
in: query
name: order
- description: 'Which field to use when ordering the results.'
+ description: Which field to use when ordering the results.
schema:
title: Ordering
type: string
Search:
in: query
name: q
- description: 'A search term.'
+ description: A search term.
schema:
title: Search
type: string
BeforeFilter:
in: query
name: before
- description: 'Latest date-time to retrieve results for.'
+ description: Latest date-time to retrieve results for.
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: 'Earliest date-time to retrieve results for.'
+ description: Earliest date-time to retrieve results for.
schema:
title: ''
type: string
headers:
Link:
- description: |
+ description: >
Links to related resources, in the format defined by
[RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).
This will include a link with relation type `next` to the
title: Owner
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
patches:
type: array
items:
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description: >
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description:
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
type: object
title: Submitter
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
content:
title: Content
type: string
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
mbox:
title: Mbox
type: string
readOnly: true
CoverLetterDetail:
allOf:
- - $ref: '#/components/schemas/CoverLetterList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/CoverLetterList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
+ readOnly: true
+ minLength: 1
EventBase:
type: object
properties:
type: object
EventCoverCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - cover-created
- payload:
- properties:
- cover:
- title: Cover
- type: string
- readOnly: true
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - cover-created
+ payload:
+ properties:
+ cover:
+ title: Cover
+ type: string
+ readOnly: true
EventPatchCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
EventPatchCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-completed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-completed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventPatchStateChanged:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-state-changed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_state:
- title: Previous state
- type: string
- current_state:
- title: Current state
- type: string
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-state-changed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_state:
+ title: Previous state
+ type: string
+ current_state:
+ title: Current state
+ type: string
EventPatchDelegated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-delegated
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Previous delegate
- current_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Current delegate
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-delegated
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Previous delegate
+ current_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Current delegate
EventCheckCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - check-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- check:
- $ref: '#/components/schemas/CheckEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - check-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ check:
+ $ref: '#/components/schemas/CheckEmbedded'
EventSeriesCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-created
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-created
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventSeriesCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-completed
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-completed
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
PatchList:
required:
- state
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
delegate:
type: object
title: Delegate
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
mbox:
title: Mbox
type: string
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
checks:
title: Checks
type: string
readOnly: true
PatchDetail:
allOf:
- - $ref: '#/components/schemas/PatchList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/PatchList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
- diff:
- title: Diff
- type: string
- readOnly: true
- minLength: 1
- prefixes:
- title: Prefixes
- type: array
- items:
+ readOnly: true
+ minLength: 1
+ diff:
+ title: Diff
type: string
- readOnly: true
+ readOnly: true
+ minLength: 1
+ prefixes:
+ title: Prefixes
+ type: array
+ items:
+ type: string
+ readOnly: true
PatchUpdate:
type: object
properties:
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
Project:
type: object
properties:
uniqueItems: true
subject_match:
title: Subject match
- description: Regex to match the subject against if only part of emails
- sent to the list belongs to this project. Will be used with
- IGNORECASE and MULTILINE flags. If rules for more projects match the
- first one returned from DB is chosen; empty field serves as a
- default for every email which has no other match.
+ description: >
+ Regex to match the subject against if only part of emails sent to
+ the list belongs to this project. Will be used with IGNORECASE and
+ MULTILINE flags. If rules for more projects match the first one
+ returned from DB is chosen; empty field serves as a default for
+ every email which has no other match.
type: string
readOnly: true
maxLength: 64
$ref: '#/components/schemas/ProjectEmbedded'
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
maxLength: 255
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
total:
title: Total
- description: Number of patches in series as indicated by the subject prefix(es)
+ description: >
+ Number of patches in series as indicated by the subject prefix(es).
type: integer
readOnly: true
received_total:
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target url
- description: The target URL to associate with this check. This should be specific
+ description: >
+ The target URL to associate with this check. This should be specific
to the patch.
type: string
format: uri
readOnly: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 255
readOnly: true
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
readOnly: true
readOnly: true
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
readOnly: true
mbox:
last_name:
title: First name
type: string
- readOnly: true
\ No newline at end of file
+ readOnly: true
{# You can obviously ignore the below when editing this template #}
# DO NOT EDIT THIS FILE. It is generated from a template. Changes should be
# proposed against the template.
+---
openapi: '3.0.0'
info:
title: Patchwork API
- description: |
+ description: >
Patchwork is a web-based patch tracking system designed to facilitate the
contribution and management of contributions to an open-source project.
contact:
schema:
$ref: '#/components/schemas/Index'
tags:
- - api
+ - api
/api/{{ version_url}}bundles/:
get:
description: List bundles.
operationId: bundles_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: owner
- description: 'An ID or username of a user to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: public
- description: 'Show only public (`true`) or private (`false`) bundles.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: owner
+ description: An ID or username of a user to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: public
+ description: Show only public (`true`) or private (`false`) bundles.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Bundle'
tags:
- - bundles
+ - bundles
/api/{{ version_url }}bundles/{id}/:
get:
description: Show a bundle.
operationId: bundles_read
parameters:
- - in: path
- name: id
- required: true
- description: 'A unique integer value identifying this bundle.'
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ required: true
+ description: A unique integer value identifying this bundle.
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Bundle'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - bundles
+ - bundles
/api/{{ version_url }}covers/:
get:
description: List cover letters.
operationId: covers_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter cover letters by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: >
+ An ID or linkname of a project to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter cover letters by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/CoverLetterList'
tags:
- - covers
+ - covers
/api/{{ version_url }}covers/{id}/:
get:
description: Show a cover letter.
operationId: covers_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this cover letter.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/CoverLetterDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - covers
+ - covers
/api/{{ version_url }}covers/{id}/comments/:
get:
description: List comments
operationId: cover_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent cover letter.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: >
+ A unique integer value identifying the parent cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/{{ version_url }}events/:
get:
description: List events.
operationId: events_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter events by.'
- schema:
- title: ''
- type: string
- - in: query
- name: category
- description: 'An event category to filter events by.'
- schema:
- title: ''
- type: string
- enum:
- - cover-created
- - patch-created
- - patch-completed
- - patch-state-changed
- - patch-delegated
- - check-created
- - series-created
- - series-completed
- - in: query
- name: series
- description: 'An ID of a series to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: patch
- description: 'An ID of a patch to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: cover
- description: 'An ID of a cover letter to filter events by.'
- schema:
- title: ''
- type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter events by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: category
+ description: An event category to filter events by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - cover-created
+ - patch-created
+ - patch-completed
+ - patch-state-changed
+ - patch-delegated
+ - check-created
+ - series-created
+ - series-completed
+ - in: query
+ name: series
+ description: An ID of a series to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: patch
+ description: An ID of a patch to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: cover
+ description: An ID of a cover letter to filter events by.
+ schema:
+ title: ''
+ type: integer
responses:
'200':
description: ''
mapping:
cover-created: '#/components/schemas/EventCoverCreated'
patch-created: '#/components/schemas/EventPatchCreated'
- patch-completed: '#/components/schemas/EventPatchCompleted'
- patch-state-changed: '#/components/schemas/EventPatchStateChanged'
- patch-delegated: '#/components/schemas/EventPatchDelegated'
+ patch-completed: >
+ '#/components/schemas/EventPatchCompleted'
+ patch-state-changed: >
+ '#/components/schemas/EventPatchStateChanged'
+ patch-delegated: >
+ '#/components/schemas/EventPatchDelegated'
check-created: '#/components/schemas/EventCheckCreated'
series-created: '#/components/schemas/EventSeriesCreated'
- series-completed: '#/components/schemas/EventSeriesCompleted'
+ series-completed: >
+ '#/components/schemas/EventSeriesCompleted'
tags:
- - events
+ - events
/api/{{ version_url }}patches/:
get:
description: List patches.
operationId: patches_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter patches by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: delegate
- description: 'An ID or username of a user to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A slug representation of a state to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: archived
- description: 'Show only archived (`true`) or non-archived (`false`) patches.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter patches by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: delegate
+ description: An ID or username of a user to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A slug representation of a state to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: archived
+ description: >
+ Show only archived (`true`) or non-archived (`false`) patches.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/PatchList'
tags:
- - patches
+ - patches
/api/{{ version_url }}patches/{id}/:
get:
description: Show a patch.
operationId: patches_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/PatchDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
patch:
description: Update a patch (partial).
operationId: patches_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
put:
description: Update a patch.
operationId: patches_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
/api/{{ version_url }}patches/{id}/comments/:
get:
description: List comments
operationId: patch_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/{{ version_url }}patches/{patch_id}/checks/:
get:
description: List checks.
operationId: checks_list
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: user
- description: 'An ID or username of a user to filter checks by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A check state to filter checks by.'
- schema:
- title: ''
- type: string
- enum:
- - pending
- - success
- - warning
- - fail
- - in: query
- name: context
- description: 'A check context to filter checks by.'
- schema:
- title: ''
- type: string
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: user
+ description: An ID or username of a user to filter checks by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A check state to filter checks by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
+ - in: query
+ name: context
+ description: A check context to filter checks by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
post:
description: Create a check.
operationId: checks_create
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
schema:
$ref: '#/components/schemas/Check'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorCheckCreate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/{{ version_url }}patches/{patch_id}/checks/{check_id}/:
get:
description: Show a check.
operationId: checks_read
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - in: path
- name: check_id
- description: 'A unique integer value identifying this check.'
- required: true
- schema:
- title: Check ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - in: path
+ name: check_id
+ description: A unique integer value identifying this check.
+ required: true
+ schema:
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/{{ version_url }}people/:
get:
description: List people.
operationId: people_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/{{ version_url }}people/{id}/:
get:
description: Show a person.
operationId: people_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this person.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this person.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/{{ version_url }}projects/:
get:
description: List projects.
operationId: projects_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Project'
tags:
- - projects
+ - projects
/api/{{ version_url }}projects/{id}/:
get:
description: Show a project.
operationId: projects_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Project'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
patch:
description: Update a project (partial).
operationId: projects_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
put:
description: Update a project.
operationId: projects_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
/api/{{ version_url }}series/:
get:
description: List series.
operationId: series_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter series by.'
- schema:
- title: ''
- type: string
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter series by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: submitter
+ description: An ID or email address of a person to filter series by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter series by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Series'
tags:
- - series
+ - series
/api/{{ version_url }}series/{id}/:
get:
description: Show a series.
operationId: series_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this series.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this series.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Series'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - series
+ - series
/api/{{ version_url }}users/:
get:
description: List users.
operationId: users_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
/api/{{ version_url }}users/{id}/:
get:
description: Show a user.
operationId: users_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
patch:
description: Update a user (partial).
operationId: users_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
put:
description: Update a user.
operationId: users_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
components:
securitySchemes:
basicAuth:
Page:
in: query
name: page
- description: 'A page number within the paginated result set.'
+ description: A page number within the paginated result set.
schema:
title: Page
type: integer
PageSize:
in: query
name: per_page
- description: 'Number of results to return per page.'
+ description: Number of results to return per page.
schema:
title: Page size
type: integer
Order:
in: query
name: order
- description: 'Which field to use when ordering the results.'
+ description: Which field to use when ordering the results.
schema:
title: Ordering
type: string
Search:
in: query
name: q
- description: 'A search term.'
+ description: A search term.
schema:
title: Search
type: string
BeforeFilter:
in: query
name: before
- description: 'Latest date-time to retrieve results for.'
+ description: Latest date-time to retrieve results for.
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: 'Earliest date-time to retrieve results for.'
+ description: Earliest date-time to retrieve results for.
schema:
title: ''
type: string
headers:
Link:
- description: |
+ description: >
Links to related resources, in the format defined by
[RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).
This will include a link with relation type `next` to the
title: Owner
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
patches:
type: array
items:
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description: >
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description:
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
type: object
title: Submitter
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
content:
title: Content
type: string
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
{% if version > (1, 0) %}
mbox:
title: Mbox
{% endif %}
CoverLetterDetail:
allOf:
- - $ref: '#/components/schemas/CoverLetterList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/CoverLetterList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
+ readOnly: true
+ minLength: 1
EventBase:
type: object
properties:
type: object
EventCoverCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - cover-created
- payload:
- properties:
- cover:
- title: Cover
- type: string
- readOnly: true
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - cover-created
+ payload:
+ properties:
+ cover:
+ title: Cover
+ type: string
+ readOnly: true
EventPatchCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
EventPatchCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-completed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-completed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventPatchStateChanged:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-state-changed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_state:
- title: Previous state
- type: string
- current_state:
- title: Current state
- type: string
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-state-changed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_state:
+ title: Previous state
+ type: string
+ current_state:
+ title: Current state
+ type: string
EventPatchDelegated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-delegated
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Previous delegate
- current_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Current delegate
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-delegated
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Previous delegate
+ current_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Current delegate
EventCheckCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - check-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- check:
- $ref: '#/components/schemas/CheckEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - check-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ check:
+ $ref: '#/components/schemas/CheckEmbedded'
EventSeriesCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-created
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-created
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventSeriesCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-completed
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-completed
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
PatchList:
required:
- state
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
delegate:
type: object
title: Delegate
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
mbox:
title: Mbox
type: string
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
checks:
title: Checks
type: string
readOnly: true
PatchDetail:
allOf:
- - $ref: '#/components/schemas/PatchList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/PatchList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
- diff:
- title: Diff
- type: string
- readOnly: true
- minLength: 1
- prefixes:
- title: Prefixes
- type: array
- items:
+ readOnly: true
+ minLength: 1
+ diff:
+ title: Diff
type: string
- readOnly: true
+ readOnly: true
+ minLength: 1
+ prefixes:
+ title: Prefixes
+ type: array
+ items:
+ type: string
+ readOnly: true
PatchUpdate:
type: object
properties:
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
Project:
type: object
properties:
{% if version > (1, 0) %}
subject_match:
title: Subject match
- description: Regex to match the subject against if only part of emails
- sent to the list belongs to this project. Will be used with
- IGNORECASE and MULTILINE flags. If rules for more projects match the
- first one returned from DB is chosen; empty field serves as a
- default for every email which has no other match.
+ description: >
+ Regex to match the subject against if only part of emails sent to
+ the list belongs to this project. Will be used with IGNORECASE and
+ MULTILINE flags. If rules for more projects match the first one
+ returned from DB is chosen; empty field serves as a default for
+ every email which has no other match.
type: string
readOnly: true
maxLength: 64
$ref: '#/components/schemas/ProjectEmbedded'
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
maxLength: 255
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
total:
title: Total
- description: Number of patches in series as indicated by the subject prefix(es)
+ description: >
+ Number of patches in series as indicated by the subject prefix(es).
type: integer
readOnly: true
received_total:
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target url
- description: The target URL to associate with this check. This should be specific
+ description: >
+ The target URL to associate with this check. This should be specific
to the patch.
type: string
format: uri
readOnly: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 255
{% endif %}
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
readOnly: true
readOnly: true
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
readOnly: true
mbox:
# DO NOT EDIT THIS FILE. It is generated from a template. Changes should be
# proposed against the template.
+---
openapi: '3.0.0'
info:
title: Patchwork API
- description: |
+ description: >
Patchwork is a web-based patch tracking system designed to facilitate the
contribution and management of contributions to an open-source project.
contact:
schema:
$ref: '#/components/schemas/Index'
tags:
- - api
+ - api
/api/1.0/bundles/:
get:
description: List bundles.
operationId: bundles_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: owner
- description: 'An ID or username of a user to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: public
- description: 'Show only public (`true`) or private (`false`) bundles.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: owner
+ description: An ID or username of a user to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: public
+ description: Show only public (`true`) or private (`false`) bundles.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Bundle'
tags:
- - bundles
+ - bundles
/api/1.0/bundles/{id}/:
get:
description: Show a bundle.
operationId: bundles_read
parameters:
- - in: path
- name: id
- required: true
- description: 'A unique integer value identifying this bundle.'
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ required: true
+ description: A unique integer value identifying this bundle.
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Bundle'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - bundles
+ - bundles
/api/1.0/covers/:
get:
description: List cover letters.
operationId: covers_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter cover letters by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: >
+ An ID or linkname of a project to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter cover letters by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/CoverLetterList'
tags:
- - covers
+ - covers
/api/1.0/covers/{id}/:
get:
description: Show a cover letter.
operationId: covers_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this cover letter.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/CoverLetterDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - covers
+ - covers
/api/1.0/covers/{id}/comments/:
get:
description: List comments
operationId: cover_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent cover letter.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: >
+ A unique integer value identifying the parent cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/1.0/events/:
get:
description: List events.
operationId: events_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter events by.'
- schema:
- title: ''
- type: string
- - in: query
- name: category
- description: 'An event category to filter events by.'
- schema:
- title: ''
- type: string
- enum:
- - cover-created
- - patch-created
- - patch-completed
- - patch-state-changed
- - patch-delegated
- - check-created
- - series-created
- - series-completed
- - in: query
- name: series
- description: 'An ID of a series to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: patch
- description: 'An ID of a patch to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: cover
- description: 'An ID of a cover letter to filter events by.'
- schema:
- title: ''
- type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter events by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: category
+ description: An event category to filter events by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - cover-created
+ - patch-created
+ - patch-completed
+ - patch-state-changed
+ - patch-delegated
+ - check-created
+ - series-created
+ - series-completed
+ - in: query
+ name: series
+ description: An ID of a series to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: patch
+ description: An ID of a patch to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: cover
+ description: An ID of a cover letter to filter events by.
+ schema:
+ title: ''
+ type: integer
responses:
'200':
description: ''
mapping:
cover-created: '#/components/schemas/EventCoverCreated'
patch-created: '#/components/schemas/EventPatchCreated'
- patch-completed: '#/components/schemas/EventPatchCompleted'
- patch-state-changed: '#/components/schemas/EventPatchStateChanged'
- patch-delegated: '#/components/schemas/EventPatchDelegated'
+ patch-completed: >
+ '#/components/schemas/EventPatchCompleted'
+ patch-state-changed: >
+ '#/components/schemas/EventPatchStateChanged'
+ patch-delegated: >
+ '#/components/schemas/EventPatchDelegated'
check-created: '#/components/schemas/EventCheckCreated'
series-created: '#/components/schemas/EventSeriesCreated'
- series-completed: '#/components/schemas/EventSeriesCompleted'
+ series-completed: >
+ '#/components/schemas/EventSeriesCompleted'
tags:
- - events
+ - events
/api/1.0/patches/:
get:
description: List patches.
operationId: patches_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter patches by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: delegate
- description: 'An ID or username of a user to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A slug representation of a state to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: archived
- description: 'Show only archived (`true`) or non-archived (`false`) patches.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter patches by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: delegate
+ description: An ID or username of a user to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A slug representation of a state to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: archived
+ description: >
+ Show only archived (`true`) or non-archived (`false`) patches.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/PatchList'
tags:
- - patches
+ - patches
/api/1.0/patches/{id}/:
get:
description: Show a patch.
operationId: patches_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/PatchDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
patch:
description: Update a patch (partial).
operationId: patches_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
put:
description: Update a patch.
operationId: patches_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
/api/1.0/patches/{id}/comments/:
get:
description: List comments
operationId: patch_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/1.0/patches/{patch_id}/checks/:
get:
description: List checks.
operationId: checks_list
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: user
- description: 'An ID or username of a user to filter checks by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A check state to filter checks by.'
- schema:
- title: ''
- type: string
- enum:
- - pending
- - success
- - warning
- - fail
- - in: query
- name: context
- description: 'A check context to filter checks by.'
- schema:
- title: ''
- type: string
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: user
+ description: An ID or username of a user to filter checks by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A check state to filter checks by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
+ - in: query
+ name: context
+ description: A check context to filter checks by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
post:
description: Create a check.
operationId: checks_create
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
schema:
$ref: '#/components/schemas/Check'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorCheckCreate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/1.0/patches/{patch_id}/checks/{check_id}/:
get:
description: Show a check.
operationId: checks_read
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - in: path
- name: check_id
- description: 'A unique integer value identifying this check.'
- required: true
- schema:
- title: Check ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - in: path
+ name: check_id
+ description: A unique integer value identifying this check.
+ required: true
+ schema:
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/1.0/people/:
get:
description: List people.
operationId: people_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/1.0/people/{id}/:
get:
description: Show a person.
operationId: people_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this person.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this person.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/1.0/projects/:
get:
description: List projects.
operationId: projects_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Project'
tags:
- - projects
+ - projects
/api/1.0/projects/{id}/:
get:
description: Show a project.
operationId: projects_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Project'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
patch:
description: Update a project (partial).
operationId: projects_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
put:
description: Update a project.
operationId: projects_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
/api/1.0/series/:
get:
description: List series.
operationId: series_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter series by.'
- schema:
- title: ''
- type: string
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter series by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: submitter
+ description: An ID or email address of a person to filter series by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter series by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Series'
tags:
- - series
+ - series
/api/1.0/series/{id}/:
get:
description: Show a series.
operationId: series_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this series.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this series.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Series'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - series
+ - series
/api/1.0/users/:
get:
description: List users.
operationId: users_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
/api/1.0/users/{id}/:
get:
description: Show a user.
operationId: users_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
patch:
description: Update a user (partial).
operationId: users_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
put:
description: Update a user.
operationId: users_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
components:
securitySchemes:
basicAuth:
Page:
in: query
name: page
- description: 'A page number within the paginated result set.'
+ description: A page number within the paginated result set.
schema:
title: Page
type: integer
PageSize:
in: query
name: per_page
- description: 'Number of results to return per page.'
+ description: Number of results to return per page.
schema:
title: Page size
type: integer
Order:
in: query
name: order
- description: 'Which field to use when ordering the results.'
+ description: Which field to use when ordering the results.
schema:
title: Ordering
type: string
Search:
in: query
name: q
- description: 'A search term.'
+ description: A search term.
schema:
title: Search
type: string
BeforeFilter:
in: query
name: before
- description: 'Latest date-time to retrieve results for.'
+ description: Latest date-time to retrieve results for.
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: 'Earliest date-time to retrieve results for.'
+ description: Earliest date-time to retrieve results for.
schema:
title: ''
type: string
headers:
Link:
- description: |
+ description: >
Links to related resources, in the format defined by
[RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).
This will include a link with relation type `next` to the
title: Owner
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
patches:
type: array
items:
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description: >
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description:
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
type: object
title: Submitter
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
content:
title: Content
type: string
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
series:
type: array
items:
readOnly: true
CoverLetterDetail:
allOf:
- - $ref: '#/components/schemas/CoverLetterList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/CoverLetterList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
+ readOnly: true
+ minLength: 1
EventBase:
type: object
properties:
type: object
EventCoverCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - cover-created
- payload:
- properties:
- cover:
- title: Cover
- type: string
- readOnly: true
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - cover-created
+ payload:
+ properties:
+ cover:
+ title: Cover
+ type: string
+ readOnly: true
EventPatchCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
EventPatchCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-completed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-completed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventPatchStateChanged:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-state-changed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_state:
- title: Previous state
- type: string
- current_state:
- title: Current state
- type: string
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-state-changed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_state:
+ title: Previous state
+ type: string
+ current_state:
+ title: Current state
+ type: string
EventPatchDelegated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-delegated
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Previous delegate
- current_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Current delegate
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-delegated
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Previous delegate
+ current_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Current delegate
EventCheckCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - check-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- check:
- $ref: '#/components/schemas/CheckEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - check-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ check:
+ $ref: '#/components/schemas/CheckEmbedded'
EventSeriesCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-created
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-created
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventSeriesCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-completed
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-completed
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
PatchList:
required:
- state
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
delegate:
type: object
title: Delegate
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
mbox:
title: Mbox
type: string
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
checks:
title: Checks
type: string
readOnly: true
PatchDetail:
allOf:
- - $ref: '#/components/schemas/PatchList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/PatchList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
- diff:
- title: Diff
- type: string
- readOnly: true
- minLength: 1
- prefixes:
- title: Prefixes
- type: array
- items:
+ readOnly: true
+ minLength: 1
+ diff:
+ title: Diff
type: string
- readOnly: true
+ readOnly: true
+ minLength: 1
+ prefixes:
+ title: Prefixes
+ type: array
+ items:
+ type: string
+ readOnly: true
PatchUpdate:
type: object
properties:
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
Project:
type: object
properties:
$ref: '#/components/schemas/ProjectEmbedded'
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
maxLength: 255
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
total:
title: Total
- description: Number of patches in series as indicated by the subject prefix(es)
+ description: >
+ Number of patches in series as indicated by the subject prefix(es).
type: integer
readOnly: true
received_total:
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target url
- description: The target URL to associate with this check. This should be specific
+ description: >
+ The target URL to associate with this check. This should be specific
to the patch.
type: string
format: uri
readOnly: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 255
readOnly: true
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
readOnly: true
readOnly: true
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
readOnly: true
mbox:
last_name:
title: First name
type: string
- readOnly: true
\ No newline at end of file
+ readOnly: true
# DO NOT EDIT THIS FILE. It is generated from a template. Changes should be
# proposed against the template.
+---
openapi: '3.0.0'
info:
title: Patchwork API
- description: |
+ description: >
Patchwork is a web-based patch tracking system designed to facilitate the
contribution and management of contributions to an open-source project.
contact:
schema:
$ref: '#/components/schemas/Index'
tags:
- - api
+ - api
/api/1.1/bundles/:
get:
description: List bundles.
operationId: bundles_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: owner
- description: 'An ID or username of a user to filter bundles by.'
- schema:
- title: ''
- type: string
- - in: query
- name: public
- description: 'Show only public (`true`) or private (`false`) bundles.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: owner
+ description: An ID or username of a user to filter bundles by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: public
+ description: Show only public (`true`) or private (`false`) bundles.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Bundle'
tags:
- - bundles
+ - bundles
/api/1.1/bundles/{id}/:
get:
description: Show a bundle.
operationId: bundles_read
parameters:
- - in: path
- name: id
- required: true
- description: 'A unique integer value identifying this bundle.'
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ required: true
+ description: A unique integer value identifying this bundle.
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Bundle'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - bundles
+ - bundles
/api/1.1/covers/:
get:
description: List cover letters.
operationId: covers_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter cover letters by.'
- schema:
- title: ''
- type: string
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter cover letters by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: >
+ An ID or linkname of a project to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter cover letters by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter cover letters by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/CoverLetterList'
tags:
- - covers
+ - covers
/api/1.1/covers/{id}/:
get:
description: Show a cover letter.
operationId: covers_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this cover letter.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/CoverLetterDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - covers
+ - covers
/api/1.1/covers/{id}/comments/:
get:
description: List comments
operationId: cover_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent cover letter.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: >
+ A unique integer value identifying the parent cover letter.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/1.1/events/:
get:
description: List events.
operationId: events_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter events by.'
- schema:
- title: ''
- type: string
- - in: query
- name: category
- description: 'An event category to filter events by.'
- schema:
- title: ''
- type: string
- enum:
- - cover-created
- - patch-created
- - patch-completed
- - patch-state-changed
- - patch-delegated
- - check-created
- - series-created
- - series-completed
- - in: query
- name: series
- description: 'An ID of a series to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: patch
- description: 'An ID of a patch to filter events by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: cover
- description: 'An ID of a cover letter to filter events by.'
- schema:
- title: ''
- type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter events by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: category
+ description: An event category to filter events by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - cover-created
+ - patch-created
+ - patch-completed
+ - patch-state-changed
+ - patch-delegated
+ - check-created
+ - series-created
+ - series-completed
+ - in: query
+ name: series
+ description: An ID of a series to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: patch
+ description: An ID of a patch to filter events by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: cover
+ description: An ID of a cover letter to filter events by.
+ schema:
+ title: ''
+ type: integer
responses:
'200':
description: ''
mapping:
cover-created: '#/components/schemas/EventCoverCreated'
patch-created: '#/components/schemas/EventPatchCreated'
- patch-completed: '#/components/schemas/EventPatchCompleted'
- patch-state-changed: '#/components/schemas/EventPatchStateChanged'
- patch-delegated: '#/components/schemas/EventPatchDelegated'
+ patch-completed: >
+ '#/components/schemas/EventPatchCompleted'
+ patch-state-changed: >
+ '#/components/schemas/EventPatchStateChanged'
+ patch-delegated: >
+ '#/components/schemas/EventPatchDelegated'
check-created: '#/components/schemas/EventCheckCreated'
series-created: '#/components/schemas/EventSeriesCreated'
- series-completed: '#/components/schemas/EventSeriesCompleted'
+ series-completed: >
+ '#/components/schemas/EventSeriesCompleted'
tags:
- - events
+ - events
/api/1.1/patches/:
get:
description: List patches.
operationId: patches_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: series
- description: 'An ID of a series to filter patches by.'
- schema:
- title: ''
- type: integer
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: delegate
- description: 'An ID or username of a user to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A slug representation of a state to filter patches by.'
- schema:
- title: ''
- type: string
- - in: query
- name: archived
- description: 'Show only archived (`true`) or non-archived (`false`) patches.'
- schema:
- title: ''
- type: string
- enum:
- - 'true'
- - 'false'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: series
+ description: An ID of a series to filter patches by.
+ schema:
+ title: ''
+ type: integer
+ - in: query
+ name: submitter
+ description: >
+ An ID or email address of a person to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: delegate
+ description: An ID or username of a user to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A slug representation of a state to filter patches by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: archived
+ description: >
+ Show only archived (`true`) or non-archived (`false`) patches.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/PatchList'
tags:
- - patches
+ - patches
/api/1.1/patches/{id}/:
get:
description: Show a patch.
operationId: patches_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/PatchDetail'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
patch:
description: Update a patch (partial).
operationId: patches_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
put:
description: Update a patch.
operationId: patches_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this patch.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
schema:
$ref: '#/components/schemas/PatchDetail'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorPatchUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - patches
+ - patches
/api/1.1/patches/{id}/comments/:
get:
description: List comments
operationId: patch_comments_list
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - in: path
+ name: id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Comment'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - comments
+ - comments
/api/1.1/patches/{patch_id}/checks/:
get:
description: List checks.
operationId: checks_list
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: user
- description: 'An ID or username of a user to filter checks by.'
- schema:
- title: ''
- type: string
- - in: query
- name: state
- description: 'A check state to filter checks by.'
- schema:
- title: ''
- type: string
- enum:
- - pending
- - success
- - warning
- - fail
- - in: query
- name: context
- description: 'A check context to filter checks by.'
- schema:
- title: ''
- type: string
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: user
+ description: An ID or username of a user to filter checks by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: state
+ description: A check state to filter checks by.
+ schema:
+ title: ''
+ type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
+ - in: query
+ name: context
+ description: A check context to filter checks by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
post:
description: Create a check.
operationId: checks_create
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
schema:
$ref: '#/components/schemas/Check'
'400':
- description: 'Invalid Request'
+ description: Invalid Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorCheckCreate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/1.1/patches/{patch_id}/checks/{check_id}/:
get:
description: Show a check.
operationId: checks_read
parameters:
- - in: path
- name: patch_id
- description: 'A unique integer value identifying the parent patch.'
- required: true
- schema:
- title: Patch ID
- type: integer
- - in: path
- name: check_id
- description: 'A unique integer value identifying this check.'
- required: true
- schema:
- title: Check ID
- type: integer
+ - in: path
+ name: patch_id
+ description: A unique integer value identifying the parent patch.
+ required: true
+ schema:
+ title: Patch ID
+ type: integer
+ - in: path
+ name: check_id
+ description: A unique integer value identifying this check.
+ required: true
+ schema:
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Check'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - checks
+ - checks
/api/1.1/people/:
get:
description: List people.
operationId: people_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/1.1/people/{id}/:
get:
description: Show a person.
operationId: people_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this person.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this person.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Person'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - people
+ - people
/api/1.1/projects/:
get:
description: List projects.
operationId: projects_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Project'
tags:
- - projects
+ - projects
/api/1.1/projects/{id}/:
get:
description: Show a project.
operationId: projects_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Project'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
patch:
description: Update a project (partial).
operationId: projects_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
put:
description: Update a project.
operationId: projects_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this project.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this project.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
schema:
$ref: '#/components/schemas/Project'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorProjectUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - projects
+ - projects
/api/1.1/series/:
get:
description: List series.
operationId: series_list
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
- - $ref: '#/components/parameters/BeforeFilter'
- - $ref: '#/components/parameters/SinceFilter'
- - in: query
- name: submitter
- description: 'An ID or email address of a person to filter series by.'
- schema:
- title: ''
- type: string
- - in: query
- name: project
- description: 'An ID or linkname of a project to filter series by.'
- schema:
- title: ''
- type: string
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/BeforeFilter'
+ - $ref: '#/components/parameters/SinceFilter'
+ - in: query
+ name: submitter
+ description: An ID or email address of a person to filter series by.
+ schema:
+ title: ''
+ type: string
+ - in: query
+ name: project
+ description: An ID or linkname of a project to filter series by.
+ schema:
+ title: ''
+ type: string
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/Series'
tags:
- - series
+ - series
/api/1.1/series/{id}/:
get:
description: Show a series.
operationId: series_read
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this series.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this series.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/Series'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - series
+ - series
/api/1.1/users/:
get:
description: List users.
operationId: users_list
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PageSize'
- - $ref: '#/components/parameters/Order'
- - $ref: '#/components/parameters/Search'
+ - $ref: '#/components/parameters/Page'
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/Order'
+ - $ref: '#/components/parameters/Search'
responses:
'200':
description: ''
items:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
/api/1.1/users/{id}/:
get:
description: Show a user.
operationId: users_read
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
responses:
'200':
description: ''
schema:
$ref: '#/components/schemas/User'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
patch:
description: Update a user (partial).
operationId: users_partial_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
put:
description: Update a user.
operationId: users_update
security:
- - basicAuth: []
- - apiKeyAuth: []
+ - basicAuth: []
+ - apiKeyAuth: []
parameters:
- - in: path
- name: id
- description: 'A unique integer value identifying this user.'
- required: true
- schema:
- title: ID
- type: integer
+ - in: path
+ name: id
+ description: A unique integer value identifying this user.
+ required: true
+ schema:
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/User'
responses:
schema:
$ref: '#/components/schemas/User'
'400':
- description: 'Bad request'
+ description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorUserUpdate'
'403':
- description: 'Forbidden'
+ description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
- description: 'Not found'
+ description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- - users
+ - users
components:
securitySchemes:
basicAuth:
Page:
in: query
name: page
- description: 'A page number within the paginated result set.'
+ description: A page number within the paginated result set.
schema:
title: Page
type: integer
PageSize:
in: query
name: per_page
- description: 'Number of results to return per page.'
+ description: Number of results to return per page.
schema:
title: Page size
type: integer
Order:
in: query
name: order
- description: 'Which field to use when ordering the results.'
+ description: Which field to use when ordering the results.
schema:
title: Ordering
type: string
Search:
in: query
name: q
- description: 'A search term.'
+ description: A search term.
schema:
title: Search
type: string
BeforeFilter:
in: query
name: before
- description: 'Latest date-time to retrieve results for.'
+ description: Latest date-time to retrieve results for.
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: 'Earliest date-time to retrieve results for.'
+ description: Earliest date-time to retrieve results for.
schema:
title: ''
type: string
headers:
Link:
- description: |
+ description: >
Links to related resources, in the format defined by
[RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).
This will include a link with relation type `next` to the
title: Owner
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
patches:
type: array
items:
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description: >
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
description: The state of the check.
type: string
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target URL
- description: The target URL to associate with this check. This should be specific
- to the patch.
+ description:
+ The target URL to associate with this check. This should be
+ specific to the patch.
type: string
format: uri
maxLength: 200
nullable: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
minLength: 1
type: object
title: Submitter
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
content:
title: Content
type: string
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
mbox:
title: Mbox
type: string
readOnly: true
CoverLetterDetail:
allOf:
- - $ref: '#/components/schemas/CoverLetterList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/CoverLetterList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
+ readOnly: true
+ minLength: 1
EventBase:
type: object
properties:
type: object
EventCoverCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - cover-created
- payload:
- properties:
- cover:
- title: Cover
- type: string
- readOnly: true
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - cover-created
+ payload:
+ properties:
+ cover:
+ title: Cover
+ type: string
+ readOnly: true
EventPatchCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
EventPatchCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-completed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-completed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventPatchStateChanged:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-state-changed
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_state:
- title: Previous state
- type: string
- current_state:
- title: Current state
- type: string
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-state-changed
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_state:
+ title: Previous state
+ type: string
+ current_state:
+ title: Current state
+ type: string
EventPatchDelegated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - patch-delegated
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- previous_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Previous delegate
- current_delegate:
- allOf:
- - $ref: '#/components/schemas/UserEmbedded'
- - title: Current delegate
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - patch-delegated
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ previous_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Previous delegate
+ current_delegate:
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+ - title: Current delegate
EventCheckCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - check-created
- payload:
- properties:
- patch:
- $ref: '#/components/schemas/PatchEmbedded'
- check:
- $ref: '#/components/schemas/CheckEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - check-created
+ payload:
+ properties:
+ patch:
+ $ref: '#/components/schemas/PatchEmbedded'
+ check:
+ $ref: '#/components/schemas/CheckEmbedded'
EventSeriesCreated:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-created
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-created
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
EventSeriesCompleted:
allOf:
- - $ref: '#/components/schemas/EventBase'
- - type: object
- properties:
- category:
- enum:
- - series-completed
- payload:
- properties:
- series:
- $ref: '#/components/schemas/SeriesEmbedded'
+ - $ref: '#/components/schemas/EventBase'
+ - type: object
+ properties:
+ category:
+ enum:
+ - series-completed
+ payload:
+ properties:
+ series:
+ $ref: '#/components/schemas/SeriesEmbedded'
PatchList:
required:
- state
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
delegate:
type: object
title: Delegate
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
mbox:
title: Mbox
type: string
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
checks:
title: Checks
type: string
readOnly: true
PatchDetail:
allOf:
- - $ref: '#/components/schemas/PatchList'
- - properties:
- headers:
- title: Headers
- type: array
- items:
+ - $ref: '#/components/schemas/PatchList'
+ - properties:
+ headers:
+ title: Headers
+ type: array
+ items:
+ type: string
+ readOnly: true
+ content:
+ title: Content
type: string
- readOnly: true
- content:
- title: Content
- type: string
- readOnly: true
- minLength: 1
- diff:
- title: Diff
- type: string
- readOnly: true
- minLength: 1
- prefixes:
- title: Prefixes
- type: array
- items:
+ readOnly: true
+ minLength: 1
+ diff:
+ title: Diff
type: string
- readOnly: true
+ readOnly: true
+ minLength: 1
+ prefixes:
+ title: Prefixes
+ type: array
+ items:
+ type: string
+ readOnly: true
PatchUpdate:
type: object
properties:
nullable: true
readOnly: true
allOf:
- - $ref: '#/components/schemas/UserEmbedded'
+ - $ref: '#/components/schemas/UserEmbedded'
Project:
type: object
properties:
uniqueItems: true
subject_match:
title: Subject match
- description: Regex to match the subject against if only part of emails
- sent to the list belongs to this project. Will be used with
- IGNORECASE and MULTILINE flags. If rules for more projects match the
- first one returned from DB is chosen; empty field serves as a
- default for every email which has no other match.
+ description: >
+ Regex to match the subject against if only part of emails sent to
+ the list belongs to this project. Will be used with IGNORECASE and
+ MULTILINE flags. If rules for more projects match the first one
+ returned from DB is chosen; empty field serves as a default for
+ every email which has no other match.
type: string
readOnly: true
maxLength: 64
$ref: '#/components/schemas/ProjectEmbedded'
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
maxLength: 255
title: Submitter
readOnly: true
allOf:
- - $ref: '#/components/schemas/PersonEmbedded'
+ - $ref: '#/components/schemas/PersonEmbedded'
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
total:
title: Total
- description: Number of patches in series as indicated by the subject prefix(es)
+ description: >
+ Number of patches in series as indicated by the subject prefix(es).
type: integer
readOnly: true
received_total:
type: string
readOnly: true
enum:
- - pending
- - success
- - warning
- - fail
+ - pending
+ - success
+ - warning
+ - fail
target_url:
title: Target url
- description: The target URL to associate with this check. This should be specific
+ description: >
+ The target URL to associate with this check. This should be specific
to the patch.
type: string
format: uri
readOnly: true
context:
title: Context
- description: A label to discern check from checks of other testing systems.
+ description: >
+ A label to discern check from checks of other testing systems.
type: string
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 255
readOnly: true
name:
title: Name
- description: An optional name to associate with the series, e.g. "John's PCI
+ description: >
+ An optional name to associate with the series, e.g. "John's PCI
series".
type: string
readOnly: true
readOnly: true
version:
title: Version
- description: Version of series as indicated by the subject prefix(es)
+ description: >
+ Version of series as indicated by the subject prefix(es).
type: integer
readOnly: true
mbox:
last_name:
title: First name
type: string
- readOnly: true
\ No newline at end of file
+ readOnly: true
projects / thirdparty / patchwork.git / commitdiff
