From 11131063b49b81d86cf51a8c2704370997db3d38 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Thu, 16 Apr 2020 11:43:04 +0100 Subject: docs: Move common path parameters to parent Turns out you don't have to nest common elements under individual routes [1]. Less duplication and more sensible docs = winning. [1] https://swagger.io/specification/#pathItemObject Signed-off-by: Stephen Finucane --- docs/api/schemas/latest/patchwork.yaml | 261 ++++++++++++--------------------- docs/api/schemas/patchwork.j2 | 261 ++++++++++++--------------------- docs/api/schemas/v1.0/patchwork.yaml | 245 ++++++++++++------------------- docs/api/schemas/v1.1/patchwork.yaml | 245 ++++++++++++------------------- docs/api/schemas/v1.2/patchwork.yaml | 261 ++++++++++++--------------------- 5 files changed, 480 insertions(+), 793 deletions(-) diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml index c4928a7..6232d87 100644 --- a/docs/api/schemas/latest/patchwork.yaml +++ b/docs/api/schemas/latest/patchwork.yaml @@ -103,17 +103,17 @@ paths: tags: - bundles /api/bundles/{id}/: + parameters: + - in: path + name: id + required: true + description: A unique integer value identifying this bundle. + schema: + title: ID + type: integer get: description: Show a bundle. operationId: bundles_read - parameters: - - in: path - name: id - required: true - description: A unique integer value identifying this bundle. - schema: - title: ID - type: integer responses: '200': description: '' @@ -135,14 +135,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this bundle. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Bundle' responses: @@ -178,14 +170,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this bundle. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Bundle' responses: @@ -269,17 +253,17 @@ paths: tags: - covers /api/covers/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this cover letter. + required: true + schema: + title: ID + type: integer get: description: Show a cover letter. operationId: covers_read - parameters: - - in: path - name: id - description: A unique integer value identifying this cover letter. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -296,18 +280,19 @@ paths: tags: - covers /api/covers/{id}/comments/: + parameters: + - in: path + name: id + description: > + A unique integer value identifying the parent cover letter. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: cover_comments_list parameters: - - in: path - name: id - description: > - A unique integer value identifying the parent cover letter. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -505,17 +490,17 @@ paths: tags: - patches /api/patches/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this patch. + required: true + schema: + title: ID + type: integer get: description: Show a patch. operationId: patches_read - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -537,14 +522,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -586,14 +563,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -630,17 +599,18 @@ paths: tags: - patches /api/patches/{id}/comments/: + parameters: + - in: path + name: id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: patch_comments_list parameters: - - in: path - name: id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -666,17 +636,18 @@ paths: tags: - comments /api/patches/{patch_id}/checks/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer get: description: List checks. operationId: checks_list parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -732,14 +703,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer requestBody: $ref: '#/components/requestBodies/Check' responses: @@ -770,24 +733,24 @@ paths: tags: - checks /api/patches/{patch_id}/checks/{check_id}/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: check_id + description: A unique integer value identifying this check. + required: true + schema: + title: Check ID + type: integer get: description: Show a check. operationId: checks_read - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - - in: path - name: check_id - description: A unique integer value identifying this check. - required: true - schema: - title: Check ID - type: integer responses: '200': description: '' @@ -836,20 +799,20 @@ paths: tags: - people /api/people/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this person. + required: true + schema: + title: ID + type: integer get: description: Show a person. operationId: people_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this person. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -895,17 +858,17 @@ paths: tags: - projects /api/projects/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this project. + required: true + schema: + title: ID + type: integer get: description: Show a project. operationId: projects_read - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -927,14 +890,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -970,14 +925,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -1045,17 +992,17 @@ paths: tags: - series /api/series/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this series. + required: true + schema: + title: ID + type: integer get: description: Show a series. operationId: series_read - parameters: - - in: path - name: id - description: A unique integer value identifying this series. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -1104,20 +1051,20 @@ paths: tags: - users /api/users/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this user. + required: true + schema: + title: ID + type: integer get: description: Show a user. operationId: users_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -1145,14 +1092,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: @@ -1188,14 +1127,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2 index 5491008..a1496e1 100644 --- a/docs/api/schemas/patchwork.j2 +++ b/docs/api/schemas/patchwork.j2 @@ -106,17 +106,17 @@ paths: - bundles {% endif %} /api/{{ version_url }}bundles/{id}/: + parameters: + - in: path + name: id + required: true + description: A unique integer value identifying this bundle. + schema: + title: ID + type: integer get: description: Show a bundle. operationId: bundles_read - parameters: - - in: path - name: id - required: true - description: A unique integer value identifying this bundle. - schema: - title: ID - type: integer responses: '200': description: '' @@ -139,14 +139,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this bundle. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Bundle' responses: @@ -182,14 +174,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this bundle. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Bundle' responses: @@ -276,17 +260,17 @@ paths: tags: - covers /api/{{ version_url }}covers/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this cover letter. + required: true + schema: + title: ID + type: integer get: description: Show a cover letter. operationId: covers_read - parameters: - - in: path - name: id - description: A unique integer value identifying this cover letter. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -303,18 +287,19 @@ paths: tags: - covers /api/{{ version_url }}covers/{id}/comments/: + parameters: + - in: path + name: id + description: > + A unique integer value identifying the parent cover letter. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: cover_comments_list parameters: - - in: path - name: id - description: > - A unique integer value identifying the parent cover letter. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -522,17 +507,17 @@ paths: tags: - patches /api/{{ version_url }}patches/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this patch. + required: true + schema: + title: ID + type: integer get: description: Show a patch. operationId: patches_read - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -554,14 +539,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -605,14 +582,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -651,17 +620,18 @@ paths: tags: - patches /api/{{ version_url }}patches/{id}/comments/: + parameters: + - in: path + name: id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: patch_comments_list parameters: - - in: path - name: id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -687,17 +657,18 @@ paths: tags: - comments /api/{{ version_url }}patches/{patch_id}/checks/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer get: description: List checks. operationId: checks_list parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -753,14 +724,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer requestBody: $ref: '#/components/requestBodies/Check' responses: @@ -791,24 +754,24 @@ paths: tags: - checks /api/{{ version_url }}patches/{patch_id}/checks/{check_id}/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: check_id + description: A unique integer value identifying this check. + required: true + schema: + title: Check ID + type: integer get: description: Show a check. operationId: checks_read - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - - in: path - name: check_id - description: A unique integer value identifying this check. - required: true - schema: - title: Check ID - type: integer responses: '200': description: '' @@ -857,20 +820,20 @@ paths: tags: - people /api/{{ version_url }}people/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this person. + required: true + schema: + title: ID + type: integer get: description: Show a person. operationId: people_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this person. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -916,17 +879,17 @@ paths: tags: - projects /api/{{ version_url }}projects/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this project. + required: true + schema: + title: ID + type: integer get: description: Show a project. operationId: projects_read - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -948,14 +911,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -991,14 +946,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -1066,17 +1013,17 @@ paths: tags: - series /api/{{ version_url }}series/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this series. + required: true + schema: + title: ID + type: integer get: description: Show a series. operationId: series_read - parameters: - - in: path - name: id - description: A unique integer value identifying this series. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -1125,20 +1072,20 @@ paths: tags: - users /api/{{ version_url }}users/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this user. + required: true + schema: + title: ID + type: integer get: description: Show a user. operationId: users_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -1170,14 +1117,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: @@ -1217,14 +1156,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml index 5622e87..31b8d91 100644 --- a/docs/api/schemas/v1.0/patchwork.yaml +++ b/docs/api/schemas/v1.0/patchwork.yaml @@ -74,17 +74,17 @@ paths: tags: - bundles /api/1.0/bundles/{id}/: + parameters: + - in: path + name: id + required: true + description: A unique integer value identifying this bundle. + schema: + title: ID + type: integer get: description: Show a bundle. operationId: bundles_read - parameters: - - in: path - name: id - required: true - description: A unique integer value identifying this bundle. - schema: - title: ID - type: integer responses: '200': description: '' @@ -146,17 +146,17 @@ paths: tags: - covers /api/1.0/covers/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this cover letter. + required: true + schema: + title: ID + type: integer get: description: Show a cover letter. operationId: covers_read - parameters: - - in: path - name: id - description: A unique integer value identifying this cover letter. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -173,18 +173,19 @@ paths: tags: - covers /api/1.0/covers/{id}/comments/: + parameters: + - in: path + name: id + description: > + A unique integer value identifying the parent cover letter. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: cover_comments_list parameters: - - in: path - name: id - description: > - A unique integer value identifying the parent cover letter. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -362,17 +363,17 @@ paths: tags: - patches /api/1.0/patches/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this patch. + required: true + schema: + title: ID + type: integer get: description: Show a patch. operationId: patches_read - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -394,14 +395,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -437,14 +430,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -475,17 +460,18 @@ paths: tags: - patches /api/1.0/patches/{id}/comments/: + parameters: + - in: path + name: id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: patch_comments_list parameters: - - in: path - name: id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -511,17 +497,18 @@ paths: tags: - comments /api/1.0/patches/{patch_id}/checks/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer get: description: List checks. operationId: checks_list parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -577,14 +564,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer requestBody: $ref: '#/components/requestBodies/Check' responses: @@ -615,24 +594,24 @@ paths: tags: - checks /api/1.0/patches/{patch_id}/checks/{check_id}/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: check_id + description: A unique integer value identifying this check. + required: true + schema: + title: Check ID + type: integer get: description: Show a check. operationId: checks_read - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - - in: path - name: check_id - description: A unique integer value identifying this check. - required: true - schema: - title: Check ID - type: integer responses: '200': description: '' @@ -681,20 +660,20 @@ paths: tags: - people /api/1.0/people/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this person. + required: true + schema: + title: ID + type: integer get: description: Show a person. operationId: people_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this person. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -740,17 +719,17 @@ paths: tags: - projects /api/1.0/projects/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this project. + required: true + schema: + title: ID + type: integer get: description: Show a project. operationId: projects_read - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -772,14 +751,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -815,14 +786,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -890,17 +853,17 @@ paths: tags: - series /api/1.0/series/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this series. + required: true + schema: + title: ID + type: integer get: description: Show a series. operationId: series_read - parameters: - - in: path - name: id - description: A unique integer value identifying this series. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -949,20 +912,20 @@ paths: tags: - users /api/1.0/users/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this user. + required: true + schema: + title: ID + type: integer get: description: Show a user. operationId: users_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -990,14 +953,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: @@ -1033,14 +988,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml index 43034fa..943ecc5 100644 --- a/docs/api/schemas/v1.1/patchwork.yaml +++ b/docs/api/schemas/v1.1/patchwork.yaml @@ -74,17 +74,17 @@ paths: tags: - bundles /api/1.1/bundles/{id}/: + parameters: + - in: path + name: id + required: true + description: A unique integer value identifying this bundle. + schema: + title: ID + type: integer get: description: Show a bundle. operationId: bundles_read - parameters: - - in: path - name: id - required: true - description: A unique integer value identifying this bundle. - schema: - title: ID - type: integer responses: '200': description: '' @@ -146,17 +146,17 @@ paths: tags: - covers /api/1.1/covers/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this cover letter. + required: true + schema: + title: ID + type: integer get: description: Show a cover letter. operationId: covers_read - parameters: - - in: path - name: id - description: A unique integer value identifying this cover letter. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -173,18 +173,19 @@ paths: tags: - covers /api/1.1/covers/{id}/comments/: + parameters: + - in: path + name: id + description: > + A unique integer value identifying the parent cover letter. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: cover_comments_list parameters: - - in: path - name: id - description: > - A unique integer value identifying the parent cover letter. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -362,17 +363,17 @@ paths: tags: - patches /api/1.1/patches/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this patch. + required: true + schema: + title: ID + type: integer get: description: Show a patch. operationId: patches_read - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -394,14 +395,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -437,14 +430,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -475,17 +460,18 @@ paths: tags: - patches /api/1.1/patches/{id}/comments/: + parameters: + - in: path + name: id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: patch_comments_list parameters: - - in: path - name: id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -511,17 +497,18 @@ paths: tags: - comments /api/1.1/patches/{patch_id}/checks/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer get: description: List checks. operationId: checks_list parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -577,14 +564,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer requestBody: $ref: '#/components/requestBodies/Check' responses: @@ -615,24 +594,24 @@ paths: tags: - checks /api/1.1/patches/{patch_id}/checks/{check_id}/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: check_id + description: A unique integer value identifying this check. + required: true + schema: + title: Check ID + type: integer get: description: Show a check. operationId: checks_read - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - - in: path - name: check_id - description: A unique integer value identifying this check. - required: true - schema: - title: Check ID - type: integer responses: '200': description: '' @@ -681,20 +660,20 @@ paths: tags: - people /api/1.1/people/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this person. + required: true + schema: + title: ID + type: integer get: description: Show a person. operationId: people_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this person. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -740,17 +719,17 @@ paths: tags: - projects /api/1.1/projects/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this project. + required: true + schema: + title: ID + type: integer get: description: Show a project. operationId: projects_read - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -772,14 +751,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -815,14 +786,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -890,17 +853,17 @@ paths: tags: - series /api/1.1/series/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this series. + required: true + schema: + title: ID + type: integer get: description: Show a series. operationId: series_read - parameters: - - in: path - name: id - description: A unique integer value identifying this series. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -949,20 +912,20 @@ paths: tags: - users /api/1.1/users/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this user. + required: true + schema: + title: ID + type: integer get: description: Show a user. operationId: users_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -990,14 +953,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: @@ -1033,14 +988,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml index 3b441db..8166840 100644 --- a/docs/api/schemas/v1.2/patchwork.yaml +++ b/docs/api/schemas/v1.2/patchwork.yaml @@ -103,17 +103,17 @@ paths: tags: - bundles /api/1.2/bundles/{id}/: + parameters: + - in: path + name: id + required: true + description: A unique integer value identifying this bundle. + schema: + title: ID + type: integer get: description: Show a bundle. operationId: bundles_read - parameters: - - in: path - name: id - required: true - description: A unique integer value identifying this bundle. - schema: - title: ID - type: integer responses: '200': description: '' @@ -135,14 +135,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this bundle. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Bundle' responses: @@ -178,14 +170,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this bundle. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Bundle' responses: @@ -269,17 +253,17 @@ paths: tags: - covers /api/1.2/covers/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this cover letter. + required: true + schema: + title: ID + type: integer get: description: Show a cover letter. operationId: covers_read - parameters: - - in: path - name: id - description: A unique integer value identifying this cover letter. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -296,18 +280,19 @@ paths: tags: - covers /api/1.2/covers/{id}/comments/: + parameters: + - in: path + name: id + description: > + A unique integer value identifying the parent cover letter. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: cover_comments_list parameters: - - in: path - name: id - description: > - A unique integer value identifying the parent cover letter. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -505,17 +490,17 @@ paths: tags: - patches /api/1.2/patches/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this patch. + required: true + schema: + title: ID + type: integer get: description: Show a patch. operationId: patches_read - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -537,14 +522,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -586,14 +563,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this patch. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Patch' responses: @@ -630,17 +599,18 @@ paths: tags: - patches /api/1.2/patches/{id}/comments/: + parameters: + - in: path + name: id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: ID + type: integer get: description: List comments operationId: patch_comments_list parameters: - - in: path - name: id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -666,17 +636,18 @@ paths: tags: - comments /api/1.2/patches/{patch_id}/checks/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer get: description: List checks. operationId: checks_list parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' @@ -732,14 +703,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer requestBody: $ref: '#/components/requestBodies/Check' responses: @@ -770,24 +733,24 @@ paths: tags: - checks /api/1.2/patches/{patch_id}/checks/{check_id}/: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: check_id + description: A unique integer value identifying this check. + required: true + schema: + title: Check ID + type: integer get: description: Show a check. operationId: checks_read - parameters: - - in: path - name: patch_id - description: A unique integer value identifying the parent patch. - required: true - schema: - title: Patch ID - type: integer - - in: path - name: check_id - description: A unique integer value identifying this check. - required: true - schema: - title: Check ID - type: integer responses: '200': description: '' @@ -836,20 +799,20 @@ paths: tags: - people /api/1.2/people/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this person. + required: true + schema: + title: ID + type: integer get: description: Show a person. operationId: people_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this person. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -895,17 +858,17 @@ paths: tags: - projects /api/1.2/projects/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this project. + required: true + schema: + title: ID + type: integer get: description: Show a project. operationId: projects_read - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -927,14 +890,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -970,14 +925,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this project. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/Project' responses: @@ -1045,17 +992,17 @@ paths: tags: - series /api/1.2/series/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this series. + required: true + schema: + title: ID + type: integer get: description: Show a series. operationId: series_read - parameters: - - in: path - name: id - description: A unique integer value identifying this series. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -1104,20 +1051,20 @@ paths: tags: - users /api/1.2/users/{id}/: + parameters: + - in: path + name: id + description: A unique integer value identifying this user. + required: true + schema: + title: ID + type: integer get: description: Show a user. operationId: users_read security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer responses: '200': description: '' @@ -1145,14 +1092,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: @@ -1188,14 +1127,6 @@ paths: security: - basicAuth: [] - apiKeyAuth: [] - parameters: - - in: path - name: id - description: A unique integer value identifying this user. - required: true - schema: - title: ID - type: integer requestBody: $ref: '#/components/requestBodies/User' responses: -- cgit v1.2.3