aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2018-12-23 15:38:51 +0000
committerStephen Finucane <stephen@that.guru>2018-12-24 14:23:05 +0000
commit8e42d30896e1b50d9916e564e7455a1f5272ca74 (patch)
treea664f1f1c9fd08f8e62d02697387722728f8e60a /docs
parentde93c2de1abb908dbe5a3345533601d8212f6478 (diff)
downloadpatchwork-8e42d30896e1b50d9916e564e7455a1f5272ca74.tar
patchwork-8e42d30896e1b50d9916e564e7455a1f5272ca74.tar.gz
docs: Add parameter descriptions, types
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs')
-rw-r--r--docs/api/schemas/latest/patchwork.yaml177
-rw-r--r--docs/api/schemas/patchwork.j2177
-rw-r--r--docs/api/schemas/v1.0/patchwork.yaml177
-rw-r--r--docs/api/schemas/v1.1/patchwork.yaml177
4 files changed, 376 insertions, 332 deletions
diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index 1510b2a..f96d689 100644
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -38,22 +38,25 @@ paths:
- $ref: '#/components/parameters/Search'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: owner
- description: ''
+ description: 'An ID or username of a user to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: public
- description: ''
+ description: 'Show only public (`true`) or private (`false`) bundles.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -76,10 +79,10 @@ paths:
- in: path
name: id
required: true
- description: ''
+ description: 'A unique integer value identifying this bundle.'
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -108,19 +111,19 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter cover letters by.'
schema:
title: ''
type: string
@@ -145,11 +148,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -172,11 +175,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -214,13 +217,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter events by.'
schema:
title: ''
type: string
- in: query
name: category
- description: ''
+ description: 'An event category to filter events by.'
schema:
title: ''
type: string
@@ -235,22 +238,22 @@ paths:
- series-completed
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: patch
- description: ''
+ description: 'An ID of a patch to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: cover
- description: ''
+ description: 'An ID of a cover letter to filter events by.'
schema:
title: ''
- type: string
+ type: integer
responses:
'200':
description: ''
@@ -297,40 +300,43 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter patches by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter patches by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter patches by.'
schema:
title: ''
type: string
- in: query
name: delegate
- description: ''
+ description: 'An ID or username of a user to filter patches by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A slug representation of a state to filter patches by.'
schema:
title: ''
type: string
- in: query
name: archived
- description: ''
+ description: 'Show only archived (`true`) or non-archived (`false`) patches.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -352,11 +358,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -381,11 +387,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -424,11 +430,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -465,11 +471,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -501,11 +507,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -514,19 +520,24 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: user
- description: ''
+ description: 'An ID or username of a user to filter checks by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A check state to filter checks by.'
schema:
title: ''
type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
- in: query
name: context
- description: ''
+ description: 'A check context to filter checks by.'
schema:
title: ''
type: string
@@ -559,11 +570,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
@@ -600,18 +611,18 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- in: path
name: check_id
- description: ''
+ description: 'A unique integer value identifying this check.'
required: true
schema:
- title: ''
- type: string
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
@@ -669,11 +680,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this person.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -725,11 +736,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -754,11 +765,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -797,11 +808,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -844,13 +855,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter series by.'
schema:
title: ''
type: string
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter series by.'
schema:
title: ''
type: string
@@ -875,11 +886,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this series.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -937,7 +948,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -972,7 +983,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1015,7 +1026,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1061,42 +1072,42 @@ components:
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: ''
+ description: 'Latest date-time to retrieve results for.'
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: ''
+ description: 'Earliest date-time to retrieve results for.'
schema:
title: ''
type: string
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index 208d01f..c0f330f 100644
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -39,22 +39,25 @@ paths:
- $ref: '#/components/parameters/Search'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: owner
- description: ''
+ description: 'An ID or username of a user to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: public
- description: ''
+ description: 'Show only public (`true`) or private (`false`) bundles.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -77,10 +80,10 @@ paths:
- in: path
name: id
required: true
- description: ''
+ description: 'A unique integer value identifying this bundle.'
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -109,19 +112,19 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter cover letters by.'
schema:
title: ''
type: string
@@ -146,11 +149,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -173,11 +176,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -215,13 +218,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter events by.'
schema:
title: ''
type: string
- in: query
name: category
- description: ''
+ description: 'An event category to filter events by.'
schema:
title: ''
type: string
@@ -236,22 +239,22 @@ paths:
- series-completed
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: patch
- description: ''
+ description: 'An ID of a patch to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: cover
- description: ''
+ description: 'An ID of a cover letter to filter events by.'
schema:
title: ''
- type: string
+ type: integer
responses:
'200':
description: ''
@@ -298,40 +301,43 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter patches by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter patches by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter patches by.'
schema:
title: ''
type: string
- in: query
name: delegate
- description: ''
+ description: 'An ID or username of a user to filter patches by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A slug representation of a state to filter patches by.'
schema:
title: ''
type: string
- in: query
name: archived
- description: ''
+ description: 'Show only archived (`true`) or non-archived (`false`) patches.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -353,11 +359,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -382,11 +388,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -425,11 +431,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -466,11 +472,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -502,11 +508,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -515,19 +521,24 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: user
- description: ''
+ description: 'An ID or username of a user to filter checks by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A check state to filter checks by.'
schema:
title: ''
type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
- in: query
name: context
- description: ''
+ description: 'A check context to filter checks by.'
schema:
title: ''
type: string
@@ -560,11 +571,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
@@ -601,18 +612,18 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- in: path
name: check_id
- description: ''
+ description: 'A unique integer value identifying this check.'
required: true
schema:
- title: ''
- type: string
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
@@ -670,11 +681,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this person.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -726,11 +737,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -755,11 +766,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -798,11 +809,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -845,13 +856,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter series by.'
schema:
title: ''
type: string
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter series by.'
schema:
title: ''
type: string
@@ -876,11 +887,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this series.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -938,7 +949,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -973,7 +984,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1016,7 +1027,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1062,42 +1073,42 @@ components:
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: ''
+ description: 'Latest date-time to retrieve results for.'
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: ''
+ description: 'Earliest date-time to retrieve results for.'
schema:
title: ''
type: string
diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml
index e16fd4b..ea519de 100644
--- a/docs/api/schemas/v1.0/patchwork.yaml
+++ b/docs/api/schemas/v1.0/patchwork.yaml
@@ -38,22 +38,25 @@ paths:
- $ref: '#/components/parameters/Search'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: owner
- description: ''
+ description: 'An ID or username of a user to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: public
- description: ''
+ description: 'Show only public (`true`) or private (`false`) bundles.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -76,10 +79,10 @@ paths:
- in: path
name: id
required: true
- description: ''
+ description: 'A unique integer value identifying this bundle.'
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -108,19 +111,19 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter cover letters by.'
schema:
title: ''
type: string
@@ -145,11 +148,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -172,11 +175,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -214,13 +217,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter events by.'
schema:
title: ''
type: string
- in: query
name: category
- description: ''
+ description: 'An event category to filter events by.'
schema:
title: ''
type: string
@@ -235,22 +238,22 @@ paths:
- series-completed
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: patch
- description: ''
+ description: 'An ID of a patch to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: cover
- description: ''
+ description: 'An ID of a cover letter to filter events by.'
schema:
title: ''
- type: string
+ type: integer
responses:
'200':
description: ''
@@ -297,40 +300,43 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter patches by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter patches by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter patches by.'
schema:
title: ''
type: string
- in: query
name: delegate
- description: ''
+ description: 'An ID or username of a user to filter patches by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A slug representation of a state to filter patches by.'
schema:
title: ''
type: string
- in: query
name: archived
- description: ''
+ description: 'Show only archived (`true`) or non-archived (`false`) patches.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -352,11 +358,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -381,11 +387,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -424,11 +430,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -465,11 +471,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -501,11 +507,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -514,19 +520,24 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: user
- description: ''
+ description: 'An ID or username of a user to filter checks by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A check state to filter checks by.'
schema:
title: ''
type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
- in: query
name: context
- description: ''
+ description: 'A check context to filter checks by.'
schema:
title: ''
type: string
@@ -559,11 +570,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
@@ -600,18 +611,18 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- in: path
name: check_id
- description: ''
+ description: 'A unique integer value identifying this check.'
required: true
schema:
- title: ''
- type: string
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
@@ -669,11 +680,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this person.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -725,11 +736,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -754,11 +765,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -797,11 +808,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -844,13 +855,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter series by.'
schema:
title: ''
type: string
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter series by.'
schema:
title: ''
type: string
@@ -875,11 +886,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this series.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -937,7 +948,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -972,7 +983,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1015,7 +1026,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1061,42 +1072,42 @@ components:
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: ''
+ description: 'Latest date-time to retrieve results for.'
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: ''
+ description: 'Earliest date-time to retrieve results for.'
schema:
title: ''
type: string
diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml
index 56cce53..bf66d3e 100644
--- a/docs/api/schemas/v1.1/patchwork.yaml
+++ b/docs/api/schemas/v1.1/patchwork.yaml
@@ -38,22 +38,25 @@ paths:
- $ref: '#/components/parameters/Search'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: owner
- description: ''
+ description: 'An ID or username of a user to filter bundles by.'
schema:
title: ''
type: string
- in: query
name: public
- description: ''
+ description: 'Show only public (`true`) or private (`false`) bundles.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -76,10 +79,10 @@ paths:
- in: path
name: id
required: true
- description: ''
+ description: 'A unique integer value identifying this bundle.'
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -108,19 +111,19 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter cover letters by.'
schema:
title: ''
type: string
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter cover letters by.'
schema:
title: ''
type: string
@@ -145,11 +148,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -172,11 +175,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent cover letter.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -214,13 +217,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter events by.'
schema:
title: ''
type: string
- in: query
name: category
- description: ''
+ description: 'An event category to filter events by.'
schema:
title: ''
type: string
@@ -235,22 +238,22 @@ paths:
- series-completed
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: patch
- description: ''
+ description: 'An ID of a patch to filter events by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: cover
- description: ''
+ description: 'An ID of a cover letter to filter events by.'
schema:
title: ''
- type: string
+ type: integer
responses:
'200':
description: ''
@@ -297,40 +300,43 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter patches by.'
schema:
title: ''
type: string
- in: query
name: series
- description: ''
+ description: 'An ID of a series to filter patches by.'
schema:
title: ''
- type: string
+ type: integer
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter patches by.'
schema:
title: ''
type: string
- in: query
name: delegate
- description: ''
+ description: 'An ID or username of a user to filter patches by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A slug representation of a state to filter patches by.'
schema:
title: ''
type: string
- in: query
name: archived
- description: ''
+ description: 'Show only archived (`true`) or non-archived (`false`) patches.'
schema:
title: ''
type: string
+ enum:
+ - 'true'
+ - 'false'
responses:
'200':
description: ''
@@ -352,11 +358,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -381,11 +387,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -424,11 +430,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Patch'
responses:
@@ -465,11 +471,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -501,11 +507,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/Order'
@@ -514,19 +520,24 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: user
- description: ''
+ description: 'An ID or username of a user to filter checks by.'
schema:
title: ''
type: string
- in: query
name: state
- description: ''
+ description: 'A check state to filter checks by.'
schema:
title: ''
type: string
+ enum:
+ - pending
+ - success
+ - warning
+ - fail
- in: query
name: context
- description: ''
+ description: 'A check context to filter checks by.'
schema:
title: ''
type: string
@@ -559,11 +570,11 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Check'
responses:
@@ -600,18 +611,18 @@ paths:
parameters:
- in: path
name: patch_id
- description: ''
+ description: 'A unique integer value identifying the parent patch.'
required: true
schema:
- title: ''
- type: string
+ title: Patch ID
+ type: integer
- in: path
name: check_id
- description: ''
+ description: 'A unique integer value identifying this check.'
required: true
schema:
- title: ''
- type: string
+ title: Check ID
+ type: integer
responses:
'200':
description: ''
@@ -669,11 +680,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this person.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -725,11 +736,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -754,11 +765,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -797,11 +808,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this project.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
requestBody:
$ref: '#/components/requestBodies/Project'
responses:
@@ -844,13 +855,13 @@ paths:
- $ref: '#/components/parameters/SinceFilter'
- in: query
name: submitter
- description: ''
+ description: 'An ID or email address of a person to filter series by.'
schema:
title: ''
type: string
- in: query
name: project
- description: ''
+ description: 'An ID or linkname of a project to filter series by.'
schema:
title: ''
type: string
@@ -875,11 +886,11 @@ paths:
parameters:
- in: path
name: id
- description: ''
+ description: 'A unique integer value identifying this series.'
required: true
schema:
- title: ''
- type: string
+ title: ID
+ type: integer
responses:
'200':
description: ''
@@ -937,7 +948,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -972,7 +983,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1015,7 +1026,7 @@ paths:
parameters:
- in: path
name: id
- description: A unique integer value identifying this user.
+ description: 'A unique integer value identifying this user.'
required: true
schema:
title: ID
@@ -1061,42 +1072,42 @@ components:
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: ''
+ description: 'Latest date-time to retrieve results for.'
schema:
title: ''
type: string
SinceFilter:
in: query
name: since
- description: ''
+ description: 'Earliest date-time to retrieve results for.'
schema:
title: ''
type: string