From 84ebc71406b78ead9b1ad4dc7e379085f3ee6340 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Sun, 21 Jan 2024 09:55:43 +0000 Subject: [PATCH] openapi: Add more descriptions Signed-off-by: Stephen Finucane --- docs/api/schemas/latest/patchwork.yaml | 176 ++++++++++++------------- docs/api/schemas/patchwork.j2 | 176 ++++++++++++------------- docs/api/schemas/v1.0/patchwork.yaml | 126 +++++++++--------- docs/api/schemas/v1.1/patchwork.yaml | 126 +++++++++--------- docs/api/schemas/v1.2/patchwork.yaml | 152 ++++++++++----------- docs/api/schemas/v1.3/patchwork.yaml | 176 ++++++++++++------------- 6 files changed, 466 insertions(+), 466 deletions(-) diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml index 85be3e40..2d60a2c3 100644 --- a/docs/api/schemas/latest/patchwork.yaml +++ b/docs/api/schemas/latest/patchwork.yaml @@ -22,7 +22,7 @@ paths: parameters: [] responses: '200': - description: '' + description: 'List of API resources' content: application/json: schema: @@ -61,7 +61,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of bundles' headers: Link: $ref: '#/components/headers/Link' @@ -83,19 +83,19 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '201': - description: '' + description: 'Created bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -116,13 +116,13 @@ paths: operationId: bundles_read responses: '200': - description: '' + description: 'A bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -139,25 +139,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -174,25 +174,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -240,7 +240,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of cover letters' headers: Link: $ref: '#/components/headers/Link' @@ -266,13 +266,13 @@ paths: operationId: covers_read responses: '200': - description: '' + description: 'A cover letter' content: application/json: schema: $ref: '#/components/schemas/CoverDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -299,7 +299,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -310,7 +310,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -338,13 +338,13 @@ paths: operationId: cover_comments_read responses: '200': - description: '' + description: 'A cover letter comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -358,25 +358,25 @@ paths: $ref: '#/components/requestBodies/Comment' responses: '200': - description: '' + description: 'Updated cover letter comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorCommentUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -442,7 +442,7 @@ paths: type: integer responses: '200': - description: '' + description: 'List of events' headers: Link: $ref: '#/components/headers/Link' @@ -548,7 +548,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of patches' headers: Link: $ref: '#/components/headers/Link' @@ -574,13 +574,13 @@ paths: operationId: patches_read responses: '200': - description: '' + description: 'A patch' content: application/json: schema: $ref: '#/components/schemas/PatchDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -597,31 +597,31 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -638,31 +638,31 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -688,7 +688,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -699,7 +699,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -727,13 +727,13 @@ paths: operationId: patch_comments_read responses: '200': - description: '' + description: 'A patch comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -747,25 +747,25 @@ paths: $ref: '#/components/requestBodies/Comment' responses: '200': - description: '' + description: 'Updated patch' content: application/json: schema: $ref: '#/components/schemas/Comment' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorCommentUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -816,7 +816,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of checks' headers: Link: $ref: '#/components/headers/Link' @@ -827,7 +827,7 @@ paths: items: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -844,25 +844,25 @@ paths: $ref: '#/components/requestBodies/Check' responses: '201': - description: '' + description: 'Created check' content: application/json: 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: @@ -890,13 +890,13 @@ paths: operationId: checks_read responses: '200': - description: '' + description: 'A check' content: application/json: schema: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -917,7 +917,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of people' headers: Link: $ref: '#/components/headers/Link' @@ -928,7 +928,7 @@ paths: items: $ref: '#/components/schemas/Person' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -952,19 +952,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A person' content: application/json: 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: @@ -982,7 +982,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of projects' headers: Link: $ref: '#/components/headers/Link' @@ -1009,13 +1009,13 @@ paths: operationId: projects_read responses: '200': - description: '' + description: 'A project' content: application/json: schema: $ref: '#/components/schemas/Project' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1032,25 +1032,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -1067,25 +1067,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -1117,7 +1117,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of series' headers: Link: $ref: '#/components/headers/Link' @@ -1143,13 +1143,13 @@ paths: operationId: series_read responses: '200': - description: '' + description: 'A series' content: application/json: schema: $ref: '#/components/schemas/Series' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1170,7 +1170,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of users' headers: Link: $ref: '#/components/headers/Link' @@ -1181,7 +1181,7 @@ paths: items: $ref: '#/components/schemas/User' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -1205,19 +1205,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1234,25 +1234,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '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: @@ -1269,25 +1269,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '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: diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2 index 598bf2f7..7d41cec2 100644 --- a/docs/api/schemas/patchwork.j2 +++ b/docs/api/schemas/patchwork.j2 @@ -27,7 +27,7 @@ paths: parameters: [] responses: '200': - description: '' + description: 'List of API resources' content: application/json: schema: @@ -66,7 +66,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of bundles' headers: Link: $ref: '#/components/headers/Link' @@ -89,19 +89,19 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '201': - description: '' + description: 'Created bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -123,13 +123,13 @@ paths: operationId: bundles_read responses: '200': - description: '' + description: 'A bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -147,25 +147,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -182,25 +182,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -251,7 +251,7 @@ paths: {% endif %} responses: '200': - description: '' + description: 'List of cover letters' headers: Link: $ref: '#/components/headers/Link' @@ -277,13 +277,13 @@ paths: operationId: covers_read responses: '200': - description: '' + description: 'A cover letter' content: application/json: schema: $ref: '#/components/schemas/CoverDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -310,7 +310,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -321,7 +321,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -350,13 +350,13 @@ paths: operationId: cover_comments_read responses: '200': - description: '' + description: 'A cover letter comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -370,25 +370,25 @@ paths: $ref: '#/components/requestBodies/Comment' responses: '200': - description: '' + description: 'Updated cover letter comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorCommentUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -459,7 +459,7 @@ paths: type: integer responses: '200': - description: '' + description: 'List of events' headers: Link: $ref: '#/components/headers/Link' @@ -567,7 +567,7 @@ paths: {% endif %} responses: '200': - description: '' + description: 'List of patches' headers: Link: $ref: '#/components/headers/Link' @@ -593,13 +593,13 @@ paths: operationId: patches_read responses: '200': - description: '' + description: 'A patch' content: application/json: schema: $ref: '#/components/schemas/PatchDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -616,32 +616,32 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' {% if version >= (1, 2) %} '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -659,32 +659,32 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' {% if version >= (1, 2) %} '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -711,7 +711,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -722,7 +722,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -751,13 +751,13 @@ paths: operationId: patch_comments_read responses: '200': - description: '' + description: 'A patch comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -771,25 +771,25 @@ paths: $ref: '#/components/requestBodies/Comment' responses: '200': - description: '' + description: 'Updated patch' content: application/json: schema: $ref: '#/components/schemas/Comment' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorCommentUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -841,7 +841,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of checks' headers: Link: $ref: '#/components/headers/Link' @@ -852,7 +852,7 @@ paths: items: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -869,25 +869,25 @@ paths: $ref: '#/components/requestBodies/Check' responses: '201': - description: '' + description: 'Created check' content: application/json: 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: @@ -915,13 +915,13 @@ paths: operationId: checks_read responses: '200': - description: '' + description: 'A check' content: application/json: schema: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -942,7 +942,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of people' headers: Link: $ref: '#/components/headers/Link' @@ -953,7 +953,7 @@ paths: items: $ref: '#/components/schemas/Person' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -977,19 +977,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A person' content: application/json: 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: @@ -1007,7 +1007,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of projects' headers: Link: $ref: '#/components/headers/Link' @@ -1034,13 +1034,13 @@ paths: operationId: projects_read responses: '200': - description: '' + description: 'A project' content: application/json: schema: $ref: '#/components/schemas/Project' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1057,25 +1057,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -1092,25 +1092,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -1142,7 +1142,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of series' headers: Link: $ref: '#/components/headers/Link' @@ -1168,13 +1168,13 @@ paths: operationId: series_read responses: '200': - description: '' + description: 'A series' content: application/json: schema: $ref: '#/components/schemas/Series' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1195,7 +1195,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of users' headers: Link: $ref: '#/components/headers/Link' @@ -1206,7 +1206,7 @@ paths: items: $ref: '#/components/schemas/User' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -1230,7 +1230,7 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A user' content: application/json: schema: @@ -1240,13 +1240,13 @@ paths: $ref: '#/components/schemas/User' {% endif %} '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1263,7 +1263,7 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: @@ -1273,19 +1273,19 @@ paths: $ref: '#/components/schemas/User' {% endif %} '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: @@ -1302,7 +1302,7 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: @@ -1312,19 +1312,19 @@ paths: $ref: '#/components/schemas/User' {% endif %} '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: diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml index 6afe66a5..ba326fc4 100644 --- a/docs/api/schemas/v1.0/patchwork.yaml +++ b/docs/api/schemas/v1.0/patchwork.yaml @@ -22,7 +22,7 @@ paths: parameters: [] responses: '200': - description: '' + description: 'List of API resources' content: application/json: schema: @@ -61,7 +61,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of bundles' headers: Link: $ref: '#/components/headers/Link' @@ -87,13 +87,13 @@ paths: operationId: bundles_read responses: '200': - description: '' + description: 'A bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -133,7 +133,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of cover letters' headers: Link: $ref: '#/components/headers/Link' @@ -159,13 +159,13 @@ paths: operationId: covers_read responses: '200': - description: '' + description: 'A cover letter' content: application/json: schema: $ref: '#/components/schemas/CoverDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -192,7 +192,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -203,7 +203,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -266,7 +266,7 @@ paths: type: integer responses: '200': - description: '' + description: 'List of events' headers: Link: $ref: '#/components/headers/Link' @@ -357,7 +357,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of patches' headers: Link: $ref: '#/components/headers/Link' @@ -383,13 +383,13 @@ paths: operationId: patches_read responses: '200': - description: '' + description: 'A patch' content: application/json: schema: $ref: '#/components/schemas/PatchDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -406,25 +406,25 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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: @@ -441,25 +441,25 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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: @@ -485,7 +485,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -496,7 +496,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -547,7 +547,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of checks' headers: Link: $ref: '#/components/headers/Link' @@ -558,7 +558,7 @@ paths: items: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -575,25 +575,25 @@ paths: $ref: '#/components/requestBodies/Check' responses: '201': - description: '' + description: 'Created check' content: application/json: 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: @@ -621,13 +621,13 @@ paths: operationId: checks_read responses: '200': - description: '' + description: 'A check' content: application/json: schema: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -648,7 +648,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of people' headers: Link: $ref: '#/components/headers/Link' @@ -659,7 +659,7 @@ paths: items: $ref: '#/components/schemas/Person' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -683,19 +683,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A person' content: application/json: 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: @@ -713,7 +713,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of projects' headers: Link: $ref: '#/components/headers/Link' @@ -740,13 +740,13 @@ paths: operationId: projects_read responses: '200': - description: '' + description: 'A project' content: application/json: schema: $ref: '#/components/schemas/Project' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -763,25 +763,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -798,25 +798,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -848,7 +848,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of series' headers: Link: $ref: '#/components/headers/Link' @@ -874,13 +874,13 @@ paths: operationId: series_read responses: '200': - description: '' + description: 'A series' content: application/json: schema: $ref: '#/components/schemas/Series' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -901,7 +901,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of users' headers: Link: $ref: '#/components/headers/Link' @@ -912,7 +912,7 @@ paths: items: $ref: '#/components/schemas/User' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -936,19 +936,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A user' content: application/json: 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: @@ -965,25 +965,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: 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: @@ -1000,25 +1000,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: 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: diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml index 416abd54..8b3245a0 100644 --- a/docs/api/schemas/v1.1/patchwork.yaml +++ b/docs/api/schemas/v1.1/patchwork.yaml @@ -22,7 +22,7 @@ paths: parameters: [] responses: '200': - description: '' + description: 'List of API resources' content: application/json: schema: @@ -61,7 +61,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of bundles' headers: Link: $ref: '#/components/headers/Link' @@ -87,13 +87,13 @@ paths: operationId: bundles_read responses: '200': - description: '' + description: 'A bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -133,7 +133,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of cover letters' headers: Link: $ref: '#/components/headers/Link' @@ -159,13 +159,13 @@ paths: operationId: covers_read responses: '200': - description: '' + description: 'A cover letter' content: application/json: schema: $ref: '#/components/schemas/CoverDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -192,7 +192,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -203,7 +203,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -266,7 +266,7 @@ paths: type: integer responses: '200': - description: '' + description: 'List of events' headers: Link: $ref: '#/components/headers/Link' @@ -357,7 +357,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of patches' headers: Link: $ref: '#/components/headers/Link' @@ -383,13 +383,13 @@ paths: operationId: patches_read responses: '200': - description: '' + description: 'A patch' content: application/json: schema: $ref: '#/components/schemas/PatchDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -406,25 +406,25 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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: @@ -441,25 +441,25 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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: @@ -485,7 +485,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -496,7 +496,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -547,7 +547,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of checks' headers: Link: $ref: '#/components/headers/Link' @@ -558,7 +558,7 @@ paths: items: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -575,25 +575,25 @@ paths: $ref: '#/components/requestBodies/Check' responses: '201': - description: '' + description: 'Created check' content: application/json: 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: @@ -621,13 +621,13 @@ paths: operationId: checks_read responses: '200': - description: '' + description: 'A check' content: application/json: schema: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -648,7 +648,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of people' headers: Link: $ref: '#/components/headers/Link' @@ -659,7 +659,7 @@ paths: items: $ref: '#/components/schemas/Person' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -683,19 +683,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A person' content: application/json: 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: @@ -713,7 +713,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of projects' headers: Link: $ref: '#/components/headers/Link' @@ -740,13 +740,13 @@ paths: operationId: projects_read responses: '200': - description: '' + description: 'A project' content: application/json: schema: $ref: '#/components/schemas/Project' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -763,25 +763,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -798,25 +798,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -848,7 +848,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of series' headers: Link: $ref: '#/components/headers/Link' @@ -874,13 +874,13 @@ paths: operationId: series_read responses: '200': - description: '' + description: 'A series' content: application/json: schema: $ref: '#/components/schemas/Series' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -901,7 +901,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of users' headers: Link: $ref: '#/components/headers/Link' @@ -912,7 +912,7 @@ paths: items: $ref: '#/components/schemas/User' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -936,19 +936,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A user' content: application/json: 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: @@ -965,25 +965,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: 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: @@ -1000,25 +1000,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: 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: diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml index c3c4095e..f4dcb827 100644 --- a/docs/api/schemas/v1.2/patchwork.yaml +++ b/docs/api/schemas/v1.2/patchwork.yaml @@ -22,7 +22,7 @@ paths: parameters: [] responses: '200': - description: '' + description: 'List of API resources' content: application/json: schema: @@ -61,7 +61,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of bundles' headers: Link: $ref: '#/components/headers/Link' @@ -83,19 +83,19 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '201': - description: '' + description: 'Created bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -116,13 +116,13 @@ paths: operationId: bundles_read responses: '200': - description: '' + description: 'A bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -139,25 +139,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -174,25 +174,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -240,7 +240,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of cover letters' headers: Link: $ref: '#/components/headers/Link' @@ -266,13 +266,13 @@ paths: operationId: covers_read responses: '200': - description: '' + description: 'A cover letter' content: application/json: schema: $ref: '#/components/schemas/CoverDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -299,7 +299,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -310,7 +310,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -374,7 +374,7 @@ paths: type: integer responses: '200': - description: '' + description: 'List of events' headers: Link: $ref: '#/components/headers/Link' @@ -480,7 +480,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of patches' headers: Link: $ref: '#/components/headers/Link' @@ -506,13 +506,13 @@ paths: operationId: patches_read responses: '200': - description: '' + description: 'A patch' content: application/json: schema: $ref: '#/components/schemas/PatchDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -529,31 +529,31 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -570,31 +570,31 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -620,7 +620,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -631,7 +631,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -682,7 +682,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of checks' headers: Link: $ref: '#/components/headers/Link' @@ -693,7 +693,7 @@ paths: items: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -710,25 +710,25 @@ paths: $ref: '#/components/requestBodies/Check' responses: '201': - description: '' + description: 'Created check' content: application/json: 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: @@ -756,13 +756,13 @@ paths: operationId: checks_read responses: '200': - description: '' + description: 'A check' content: application/json: schema: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -783,7 +783,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of people' headers: Link: $ref: '#/components/headers/Link' @@ -794,7 +794,7 @@ paths: items: $ref: '#/components/schemas/Person' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -818,19 +818,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A person' content: application/json: 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: @@ -848,7 +848,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of projects' headers: Link: $ref: '#/components/headers/Link' @@ -875,13 +875,13 @@ paths: operationId: projects_read responses: '200': - description: '' + description: 'A project' content: application/json: schema: $ref: '#/components/schemas/Project' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -898,25 +898,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -933,25 +933,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -983,7 +983,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of series' headers: Link: $ref: '#/components/headers/Link' @@ -1009,13 +1009,13 @@ paths: operationId: series_read responses: '200': - description: '' + description: 'A series' content: application/json: schema: $ref: '#/components/schemas/Series' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1036,7 +1036,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of users' headers: Link: $ref: '#/components/headers/Link' @@ -1047,7 +1047,7 @@ paths: items: $ref: '#/components/schemas/User' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -1071,19 +1071,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1100,25 +1100,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '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: @@ -1135,25 +1135,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '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: diff --git a/docs/api/schemas/v1.3/patchwork.yaml b/docs/api/schemas/v1.3/patchwork.yaml index 97be98eb..1b8b1819 100644 --- a/docs/api/schemas/v1.3/patchwork.yaml +++ b/docs/api/schemas/v1.3/patchwork.yaml @@ -22,7 +22,7 @@ paths: parameters: [] responses: '200': - description: '' + description: 'List of API resources' content: application/json: schema: @@ -61,7 +61,7 @@ paths: - 'false' responses: '200': - description: '' + description: 'List of bundles' headers: Link: $ref: '#/components/headers/Link' @@ -83,19 +83,19 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '201': - description: '' + description: 'Created bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -116,13 +116,13 @@ paths: operationId: bundles_read responses: '200': - description: '' + description: 'A bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -139,25 +139,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -174,25 +174,25 @@ paths: $ref: '#/components/requestBodies/Bundle' responses: '200': - description: '' + description: 'Updated bundle' content: application/json: schema: $ref: '#/components/schemas/Bundle' '400': - description: Bad request + description: 'Bad request' content: application/json: schema: $ref: '#/components/schemas/ErrorBundleCreateUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -240,7 +240,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of cover letters' headers: Link: $ref: '#/components/headers/Link' @@ -266,13 +266,13 @@ paths: operationId: covers_read responses: '200': - description: '' + description: 'A cover letter' content: application/json: schema: $ref: '#/components/schemas/CoverDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -299,7 +299,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -310,7 +310,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -338,13 +338,13 @@ paths: operationId: cover_comments_read responses: '200': - description: '' + description: 'A cover letter comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -358,25 +358,25 @@ paths: $ref: '#/components/requestBodies/Comment' responses: '200': - description: '' + description: 'Updated cover letter comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorCommentUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -442,7 +442,7 @@ paths: type: integer responses: '200': - description: '' + description: 'List of events' headers: Link: $ref: '#/components/headers/Link' @@ -548,7 +548,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of patches' headers: Link: $ref: '#/components/headers/Link' @@ -574,13 +574,13 @@ paths: operationId: patches_read responses: '200': - description: '' + description: 'A patch' content: application/json: schema: $ref: '#/components/schemas/PatchDetail' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -597,31 +597,31 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -638,31 +638,31 @@ paths: $ref: '#/components/requestBodies/Patch' responses: '200': - description: '' + description: 'An updated patch' content: application/json: 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' '409': - description: Conflict + description: 'Conflict' content: application/json: schema: @@ -688,7 +688,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of comments' headers: Link: $ref: '#/components/headers/Link' @@ -699,7 +699,7 @@ paths: items: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -727,13 +727,13 @@ paths: operationId: patch_comments_read responses: '200': - description: '' + description: 'A patch comment' content: application/json: schema: $ref: '#/components/schemas/Comment' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -747,25 +747,25 @@ paths: $ref: '#/components/requestBodies/Comment' responses: '200': - description: '' + description: 'Updated patch' content: application/json: schema: $ref: '#/components/schemas/Comment' '400': - description: Invalid Request + description: 'Invalid request' content: application/json: schema: $ref: '#/components/schemas/ErrorCommentUpdate' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -816,7 +816,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of checks' headers: Link: $ref: '#/components/headers/Link' @@ -827,7 +827,7 @@ paths: items: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -844,25 +844,25 @@ paths: $ref: '#/components/requestBodies/Check' responses: '201': - description: '' + description: 'Created check' content: application/json: 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: @@ -890,13 +890,13 @@ paths: operationId: checks_read responses: '200': - description: '' + description: 'A check' content: application/json: schema: $ref: '#/components/schemas/Check' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -917,7 +917,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of people' headers: Link: $ref: '#/components/headers/Link' @@ -928,7 +928,7 @@ paths: items: $ref: '#/components/schemas/Person' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -952,19 +952,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A person' content: application/json: 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: @@ -982,7 +982,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of projects' headers: Link: $ref: '#/components/headers/Link' @@ -1009,13 +1009,13 @@ paths: operationId: projects_read responses: '200': - description: '' + description: 'A project' content: application/json: schema: $ref: '#/components/schemas/Project' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1032,25 +1032,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -1067,25 +1067,25 @@ paths: $ref: '#/components/requestBodies/Project' responses: '200': - description: '' + description: 'Updated project' content: application/json: 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: @@ -1117,7 +1117,7 @@ paths: type: string responses: '200': - description: '' + description: 'List of series' headers: Link: $ref: '#/components/headers/Link' @@ -1143,13 +1143,13 @@ paths: operationId: series_read responses: '200': - description: '' + description: 'A series' content: application/json: schema: $ref: '#/components/schemas/Series' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1170,7 +1170,7 @@ paths: - $ref: '#/components/parameters/Search' responses: '200': - description: '' + description: 'List of users' headers: Link: $ref: '#/components/headers/Link' @@ -1181,7 +1181,7 @@ paths: items: $ref: '#/components/schemas/User' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: @@ -1205,19 +1205,19 @@ paths: - apiKeyAuth: [] responses: '200': - description: '' + description: 'A user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '403': - description: Forbidden + description: 'Forbidden' content: application/json: schema: $ref: '#/components/schemas/Error' '404': - description: Not found + description: 'Not found' content: application/json: schema: @@ -1234,25 +1234,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '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: @@ -1269,25 +1269,25 @@ paths: $ref: '#/components/requestBodies/User' responses: '200': - description: '' + description: 'Updated user' content: application/json: schema: $ref: '#/components/schemas/UserDetail' '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: -- 2.47.3