docs: Add note about 'series' querystring arg to api-ref

Signed-off-by: Stephen Finucane <stephen@that.guru>

diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index edfe3477633d42ec6113ef5059b853666a2ec99a..3cbe2fa5decb5153f65f58721c99efe876d9e7a8 100644 (file)
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -5,7 +5,7 @@
 openapi: '3.1.0'
 info:
   title: Patchwork API
-  description: >
+  description: |
     Patchwork is a web-based patch tracking system designed to facilitate the
     contribution and management of contributions to an open-source project.
   contact:
@@ -212,7 +212,7 @@ paths:
         - $ref: '#/components/parameters/SinceFilter'
         - in: query
           name: project
-          description: >
+          description: |
             An ID or linkname of a project to filter cover letters by.
           schema:
             title: ''
@@ -225,14 +225,14 @@ paths:
             type: string
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter cover letters by.
           schema:
             title: ''
             type: string
         - in: query
           name: msgid
-          description: >
+          description: |
             The cover message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -283,7 +283,7 @@ paths:
     parameters:
       - in: path
         name: id
-        description: >
+        description: |
           A unique integer value identifying the parent cover letter.
         required: true
         schema:
@@ -504,7 +504,7 @@ paths:
             type: integer
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter patches by.
           schema:
             title: ''
@@ -523,7 +523,7 @@ paths:
             type: string
         - in: query
           name: archived
-          description: >
+          description: |
             Show only archived (`true`) or non-archived (`false`) patches.
           schema:
             title: ''
@@ -533,14 +533,14 @@ paths:
               - 'false'
         - in: query
           name: hash
-          description: >
+          description: |
             The patch hash as a case-insensitive hexadecimal string, to filter by.
           schema:
             title: ''
             type: string
         - in: query
           name: msgid
-          description: >
+          description: |
             The patch message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -1514,6 +1514,9 @@ components:
           type: boolean
         mbox:
           title: Mbox
+          description: |
+            A URL to download the bundle in mbox format. Patches will be
+            ordered in the same order that they are defined in the bundle.
           type: string
           format: uri
           readOnly: true
@@ -1566,7 +1569,7 @@ components:
             - fail
         target_url:
           title: Target URL
-          description: >
+          description: |
             The target URL to associate with this check. This should be
             specific to the patch.
           type:
@@ -1579,7 +1582,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -1766,6 +1769,8 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2090,6 +2095,10 @@ components:
             - $ref: '#/components/schemas/UserEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2293,7 +2302,7 @@ components:
           uniqueItems: true
         subject_match:
           title: Subject match
-          description: >
+          description: |
             Regex to match the subject against if only part of emails sent to
             the list belongs to this project. Will be used with IGNORECASE and
             MULTILINE flags. If rules for more projects match the first one
@@ -2314,7 +2323,7 @@ components:
               maxLength: 2000
         list_archive_url_format:
           title: List archive URL format
-          description: >
+          description: |
             URL format for the list archive's Message-ID redirector. {} will be
             replaced by the Message-ID.
           type:
@@ -2349,7 +2358,7 @@ components:
           $ref: '#/components/schemas/ProjectEmbedded'
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           type:
@@ -2372,12 +2381,12 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
         total:
           title: Total
-          description: >
+          description: |
             Number of patches in series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
@@ -2391,6 +2400,8 @@ components:
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2446,13 +2457,13 @@ components:
               properties:
                 send_email:
                   title: Send email
-                  description: >
+                  description: |
                     Whether Patchwork should send email on your behalf.
                     Only present and configurable for your account.
                   type: boolean
                 items_per_page:
                   title: Items per page
-                  description: >
+                  description: |
                     Number of items to display per page (web UI).
                     Only present and configurable for your account.
                   type: integer
@@ -2491,7 +2502,7 @@ components:
             - fail
         target_url:
           title: Target url
-          description: >
+          description: |
             The target URL to associate with this check. This should be specific
             to the patch.
           readOnly: true
@@ -2505,7 +2516,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -2590,6 +2601,8 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2633,6 +2646,10 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2759,7 +2776,7 @@ components:
           readOnly: true
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           readOnly: true
@@ -2777,12 +2794,14 @@ components:
           readOnly: true
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true

diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index fba79e900f180d43223546381d0ee4ad708e1818..d4d9ed0291796333b206f0a2802ef9386c1ce0b2 100644 (file)
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -6,7 +6,7 @@
 openapi: '3.1.0'
 info:
   title: Patchwork API
-  description: >
+  description: |
     Patchwork is a web-based patch tracking system designed to facilitate the
     contribution and management of contributions to an open-source project.
   contact:
@@ -217,7 +217,7 @@ paths:
         - $ref: '#/components/parameters/SinceFilter'
         - in: query
           name: project
-          description: >
+          description: |
             An ID or linkname of a project to filter cover letters by.
           schema:
             title: ''
@@ -230,7 +230,7 @@ paths:
             type: string
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter cover letters by.
           schema:
             title: ''
@@ -238,7 +238,7 @@ paths:
 {% if version >= (1, 2) %}
         - in: query
           name: msgid
-          description: >
+          description: |
             The cover message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -290,7 +290,7 @@ paths:
     parameters:
       - in: path
         name: id
-        description: >
+        description: |
           A unique integer value identifying the parent cover letter.
         required: true
         schema:
@@ -517,7 +517,7 @@ paths:
             type: integer
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter patches by.
           schema:
             title: ''
@@ -536,7 +536,7 @@ paths:
             type: string
         - in: query
           name: archived
-          description: >
+          description: |
             Show only archived (`true`) or non-archived (`false`) patches.
           schema:
             title: ''
@@ -547,14 +547,14 @@ paths:
 {% if version >= (1, 2) %}
         - in: query
           name: hash
-          description: >
+          description: |
             The patch hash as a case-insensitive hexadecimal string, to filter by.
           schema:
             title: ''
             type: string
         - in: query
           name: msgid
-          description: >
+          description: |
             The patch message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -1568,6 +1568,9 @@ components:
           type: boolean
         mbox:
           title: Mbox
+          description: |
+            A URL to download the bundle in mbox format. Patches will be
+            ordered in the same order that they are defined in the bundle.
           type: string
           format: uri
           readOnly: true
@@ -1622,7 +1625,7 @@ components:
             - fail
         target_url:
           title: Target URL
-          description: >
+          description: |
             The target URL to associate with this check. This should be
             specific to the patch.
           type:
@@ -1635,7 +1638,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -1835,6 +1838,8 @@ components:
 {% if version >= (1, 1) %}
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2168,6 +2173,10 @@ components:
             - $ref: '#/components/schemas/UserEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2378,7 +2387,7 @@ components:
 {% if version >= (1, 1) %}
         subject_match:
           title: Subject match
-          description: >
+          description: |
             Regex to match the subject against if only part of emails sent to
             the list belongs to this project. Will be used with IGNORECASE and
             MULTILINE flags. If rules for more projects match the first one
@@ -2401,7 +2410,7 @@ components:
               maxLength: 2000
         list_archive_url_format:
           title: List archive URL format
-          description: >
+          description: |
             URL format for the list archive's Message-ID redirector. {} will be
             replaced by the Message-ID.
           type:
@@ -2439,7 +2448,7 @@ components:
           $ref: '#/components/schemas/ProjectEmbedded'
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           type:
@@ -2462,12 +2471,12 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
         total:
           title: Total
-          description: >
+          description: |
             Number of patches in series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
@@ -2481,6 +2490,8 @@ components:
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2537,13 +2548,13 @@ components:
               properties:
                 send_email:
                   title: Send email
-                  description: >
+                  description: |
                     Whether Patchwork should send email on your behalf.
                     Only present and configurable for your account.
                   type: boolean
                 items_per_page:
                   title: Items per page
-                  description: >
+                  description: |
                     Number of items to display per page (web UI).
                     Only present and configurable for your account.
                   type: integer
@@ -2583,7 +2594,7 @@ components:
             - fail
         target_url:
           title: Target url
-          description: >
+          description: |
             The target URL to associate with this check. This should be specific
             to the patch.
           readOnly: true
@@ -2597,7 +2608,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -2692,6 +2703,8 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2739,6 +2752,10 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2869,7 +2886,7 @@ components:
 {% endif %}
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           readOnly: true
@@ -2887,12 +2904,14 @@ components:
           readOnly: true
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true

diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml
index 390135eca4a055a7db0fc596b37088e3a887c2b5..37391f007d6fde3d6986795c0ddcb07ca97fd01e 100644 (file)
--- a/docs/api/schemas/v1.0/patchwork.yaml
+++ b/docs/api/schemas/v1.0/patchwork.yaml
@@ -5,7 +5,7 @@
 openapi: '3.1.0'
 info:
   title: Patchwork API
-  description: >
+  description: |
     Patchwork is a web-based patch tracking system designed to facilitate the
     contribution and management of contributions to an open-source project.
   contact:
@@ -113,7 +113,7 @@ paths:
         - $ref: '#/components/parameters/SinceFilter'
         - in: query
           name: project
-          description: >
+          description: |
             An ID or linkname of a project to filter cover letters by.
           schema:
             title: ''
@@ -126,7 +126,7 @@ paths:
             type: string
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter cover letters by.
           schema:
             title: ''
@@ -176,7 +176,7 @@ paths:
     parameters:
       - in: path
         name: id
-        description: >
+        description: |
           A unique integer value identifying the parent cover letter.
         required: true
         schema:
@@ -328,7 +328,7 @@ paths:
             type: integer
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter patches by.
           schema:
             title: ''
@@ -347,7 +347,7 @@ paths:
             type: string
         - in: query
           name: archived
-          description: >
+          description: |
             Show only archived (`true`) or non-archived (`false`) patches.
           schema:
             title: ''
@@ -1223,6 +1223,9 @@ components:
           type: boolean
         mbox:
           title: Mbox
+          description: |
+            A URL to download the bundle in mbox format. Patches will be
+            ordered in the same order that they are defined in the bundle.
           type: string
           format: uri
           readOnly: true
@@ -1256,7 +1259,7 @@ components:
             - fail
         target_url:
           title: Target URL
-          description: >
+          description: |
             The target URL to associate with this check. This should be
             specific to the patch.
           type:
@@ -1269,7 +1272,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -1694,6 +1697,10 @@ components:
             - $ref: '#/components/schemas/UserEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -1896,7 +1903,7 @@ components:
           $ref: '#/components/schemas/ProjectEmbedded'
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           type:
@@ -1919,12 +1926,12 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
         total:
           title: Total
-          description: >
+          description: |
             Number of patches in series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
@@ -1938,6 +1945,8 @@ components:
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2011,7 +2020,7 @@ components:
             - fail
         target_url:
           title: Target url
-          description: >
+          description: |
             The target URL to associate with this check. This should be specific
             to the patch.
           readOnly: true
@@ -2025,7 +2034,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -2083,6 +2092,8 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2115,6 +2126,10 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2209,7 +2224,7 @@ components:
           readOnly: true
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           readOnly: true
@@ -2227,12 +2242,14 @@ components:
           readOnly: true
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true

diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml
index 26631f75acf66cb3217d6318202305a8dd1da54e..b44766c6cae34e19f374aa07fc808f2f16c5c1ba 100644 (file)
--- a/docs/api/schemas/v1.1/patchwork.yaml
+++ b/docs/api/schemas/v1.1/patchwork.yaml
@@ -5,7 +5,7 @@
 openapi: '3.1.0'
 info:
   title: Patchwork API
-  description: >
+  description: |
     Patchwork is a web-based patch tracking system designed to facilitate the
     contribution and management of contributions to an open-source project.
   contact:
@@ -113,7 +113,7 @@ paths:
         - $ref: '#/components/parameters/SinceFilter'
         - in: query
           name: project
-          description: >
+          description: |
             An ID or linkname of a project to filter cover letters by.
           schema:
             title: ''
@@ -126,7 +126,7 @@ paths:
             type: string
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter cover letters by.
           schema:
             title: ''
@@ -176,7 +176,7 @@ paths:
     parameters:
       - in: path
         name: id
-        description: >
+        description: |
           A unique integer value identifying the parent cover letter.
         required: true
         schema:
@@ -328,7 +328,7 @@ paths:
             type: integer
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter patches by.
           schema:
             title: ''
@@ -347,7 +347,7 @@ paths:
             type: string
         - in: query
           name: archived
-          description: >
+          description: |
             Show only archived (`true`) or non-archived (`false`) patches.
           schema:
             title: ''
@@ -1228,6 +1228,9 @@ components:
           type: boolean
         mbox:
           title: Mbox
+          description: |
+            A URL to download the bundle in mbox format. Patches will be
+            ordered in the same order that they are defined in the bundle.
           type: string
           format: uri
           readOnly: true
@@ -1261,7 +1264,7 @@ components:
             - fail
         target_url:
           title: Target URL
-          description: >
+          description: |
             The target URL to associate with this check. This should be
             specific to the patch.
           type:
@@ -1274,7 +1277,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -1421,6 +1424,8 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -1724,6 +1729,10 @@ components:
             - $ref: '#/components/schemas/UserEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -1917,7 +1926,7 @@ components:
           uniqueItems: true
         subject_match:
           title: Subject match
-          description: >
+          description: |
             Regex to match the subject against if only part of emails sent to
             the list belongs to this project. Will be used with IGNORECASE and
             MULTILINE flags. If rules for more projects match the first one
@@ -1947,7 +1956,7 @@ components:
           $ref: '#/components/schemas/ProjectEmbedded'
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           type:
@@ -1970,12 +1979,12 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
         total:
           title: Total
-          description: >
+          description: |
             Number of patches in series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
@@ -1989,6 +1998,8 @@ components:
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2062,7 +2073,7 @@ components:
             - fail
         target_url:
           title: Target url
-          description: >
+          description: |
             The target URL to associate with this check. This should be specific
             to the patch.
           readOnly: true
@@ -2076,7 +2087,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -2144,6 +2155,8 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2181,6 +2194,10 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2280,7 +2297,7 @@ components:
           readOnly: true
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           readOnly: true
@@ -2298,12 +2315,14 @@ components:
           readOnly: true
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true

diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index 8da026e18b727d8f8d35eadd3e8e626823faee3f..d19fd84247745768641182642c3629735a7b5e4a 100644 (file)
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -5,7 +5,7 @@
 openapi: '3.1.0'
 info:
   title: Patchwork API
-  description: >
+  description: |
     Patchwork is a web-based patch tracking system designed to facilitate the
     contribution and management of contributions to an open-source project.
   contact:
@@ -212,7 +212,7 @@ paths:
         - $ref: '#/components/parameters/SinceFilter'
         - in: query
           name: project
-          description: >
+          description: |
             An ID or linkname of a project to filter cover letters by.
           schema:
             title: ''
@@ -225,14 +225,14 @@ paths:
             type: string
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter cover letters by.
           schema:
             title: ''
             type: string
         - in: query
           name: msgid
-          description: >
+          description: |
             The cover message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -283,7 +283,7 @@ paths:
     parameters:
       - in: path
         name: id
-        description: >
+        description: |
           A unique integer value identifying the parent cover letter.
         required: true
         schema:
@@ -436,7 +436,7 @@ paths:
             type: integer
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter patches by.
           schema:
             title: ''
@@ -455,7 +455,7 @@ paths:
             type: string
         - in: query
           name: archived
-          description: >
+          description: |
             Show only archived (`true`) or non-archived (`false`) patches.
           schema:
             title: ''
@@ -465,14 +465,14 @@ paths:
               - 'false'
         - in: query
           name: hash
-          description: >
+          description: |
             The patch hash as a case-insensitive hexadecimal string, to filter by.
           schema:
             title: ''
             type: string
         - in: query
           name: msgid
-          description: >
+          description: |
             The patch message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -1374,6 +1374,9 @@ components:
           type: boolean
         mbox:
           title: Mbox
+          description: |
+            A URL to download the bundle in mbox format. Patches will be
+            ordered in the same order that they are defined in the bundle.
           type: string
           format: uri
           readOnly: true
@@ -1426,7 +1429,7 @@ components:
             - fail
         target_url:
           title: Target URL
-          description: >
+          description: |
             The target URL to associate with this check. This should be
             specific to the patch.
           type:
@@ -1439,7 +1442,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -1608,6 +1611,8 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -1932,6 +1937,10 @@ components:
             - $ref: '#/components/schemas/UserEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2135,7 +2144,7 @@ components:
           uniqueItems: true
         subject_match:
           title: Subject match
-          description: >
+          description: |
             Regex to match the subject against if only part of emails sent to
             the list belongs to this project. Will be used with IGNORECASE and
             MULTILINE flags. If rules for more projects match the first one
@@ -2156,7 +2165,7 @@ components:
               maxLength: 2000
         list_archive_url_format:
           title: List archive URL format
-          description: >
+          description: |
             URL format for the list archive's Message-ID redirector. {} will be
             replaced by the Message-ID.
           type:
@@ -2191,7 +2200,7 @@ components:
           $ref: '#/components/schemas/ProjectEmbedded'
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           type:
@@ -2214,12 +2223,12 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
         total:
           title: Total
-          description: >
+          description: |
             Number of patches in series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
@@ -2233,6 +2242,8 @@ components:
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2288,13 +2299,13 @@ components:
               properties:
                 send_email:
                   title: Send email
-                  description: >
+                  description: |
                     Whether Patchwork should send email on your behalf.
                     Only present and configurable for your account.
                   type: boolean
                 items_per_page:
                   title: Items per page
-                  description: >
+                  description: |
                     Number of items to display per page (web UI).
                     Only present and configurable for your account.
                   type: integer
@@ -2333,7 +2344,7 @@ components:
             - fail
         target_url:
           title: Target url
-          description: >
+          description: |
             The target URL to associate with this check. This should be specific
             to the patch.
           readOnly: true
@@ -2347,7 +2358,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -2427,6 +2438,8 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2470,6 +2483,10 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2596,7 +2613,7 @@ components:
           readOnly: true
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           readOnly: true
@@ -2614,12 +2631,14 @@ components:
           readOnly: true
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true

diff --git a/docs/api/schemas/v1.3/patchwork.yaml b/docs/api/schemas/v1.3/patchwork.yaml
index f143193c9f8f8de37c843a7201797094b6617f8e..11a62ef5c356c63fa08ce537e5f59238f25390dd 100644 (file)
--- a/docs/api/schemas/v1.3/patchwork.yaml
+++ b/docs/api/schemas/v1.3/patchwork.yaml
@@ -5,7 +5,7 @@
 openapi: '3.1.0'
 info:
   title: Patchwork API
-  description: >
+  description: |
     Patchwork is a web-based patch tracking system designed to facilitate the
     contribution and management of contributions to an open-source project.
   contact:
@@ -212,7 +212,7 @@ paths:
         - $ref: '#/components/parameters/SinceFilter'
         - in: query
           name: project
-          description: >
+          description: |
             An ID or linkname of a project to filter cover letters by.
           schema:
             title: ''
@@ -225,14 +225,14 @@ paths:
             type: string
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter cover letters by.
           schema:
             title: ''
             type: string
         - in: query
           name: msgid
-          description: >
+          description: |
             The cover message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -283,7 +283,7 @@ paths:
     parameters:
       - in: path
         name: id
-        description: >
+        description: |
           A unique integer value identifying the parent cover letter.
         required: true
         schema:
@@ -504,7 +504,7 @@ paths:
             type: integer
         - in: query
           name: submitter
-          description: >
+          description: |
             An ID or email address of a person to filter patches by.
           schema:
             title: ''
@@ -523,7 +523,7 @@ paths:
             type: string
         - in: query
           name: archived
-          description: >
+          description: |
             Show only archived (`true`) or non-archived (`false`) patches.
           schema:
             title: ''
@@ -533,14 +533,14 @@ paths:
               - 'false'
         - in: query
           name: hash
-          description: >
+          description: |
             The patch hash as a case-insensitive hexadecimal string, to filter by.
           schema:
             title: ''
             type: string
         - in: query
           name: msgid
-          description: >
+          description: |
             The patch message-id as a case-sensitive string, without leading or
             trailing angle brackets, to filter by.
           schema:
@@ -1514,6 +1514,9 @@ components:
           type: boolean
         mbox:
           title: Mbox
+          description: |
+            A URL to download the bundle in mbox format. Patches will be
+            ordered in the same order that they are defined in the bundle.
           type: string
           format: uri
           readOnly: true
@@ -1566,7 +1569,7 @@ components:
             - fail
         target_url:
           title: Target URL
-          description: >
+          description: |
             The target URL to associate with this check. This should be
             specific to the patch.
           type:
@@ -1579,7 +1582,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -1766,6 +1769,8 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2090,6 +2095,10 @@ components:
             - $ref: '#/components/schemas/UserEmbedded'
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2293,7 +2302,7 @@ components:
           uniqueItems: true
         subject_match:
           title: Subject match
-          description: >
+          description: |
             Regex to match the subject against if only part of emails sent to
             the list belongs to this project. Will be used with IGNORECASE and
             MULTILINE flags. If rules for more projects match the first one
@@ -2314,7 +2323,7 @@ components:
               maxLength: 2000
         list_archive_url_format:
           title: List archive URL format
-          description: >
+          description: |
             URL format for the list archive's Message-ID redirector. {} will be
             replaced by the Message-ID.
           type:
@@ -2349,7 +2358,7 @@ components:
           $ref: '#/components/schemas/ProjectEmbedded'
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           type:
@@ -2372,12 +2381,12 @@ components:
             - $ref: '#/components/schemas/PersonEmbedded'
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
         total:
           title: Total
-          description: >
+          description: |
             Number of patches in series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
@@ -2391,6 +2400,8 @@ components:
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2446,13 +2457,13 @@ components:
               properties:
                 send_email:
                   title: Send email
-                  description: >
+                  description: |
                     Whether Patchwork should send email on your behalf.
                     Only present and configurable for your account.
                   type: boolean
                 items_per_page:
                   title: Items per page
-                  description: >
+                  description: |
                     Number of items to display per page (web UI).
                     Only present and configurable for your account.
                   type: integer
@@ -2491,7 +2502,7 @@ components:
             - fail
         target_url:
           title: Target url
-          description: >
+          description: |
             The target URL to associate with this check. This should be specific
             to the patch.
           readOnly: true
@@ -2505,7 +2516,7 @@ components:
               maxLength: 200
         context:
           title: Context
-          description: >
+          description: |
             A label to discern check from checks of other testing systems.
           type: string
           pattern: ^[-a-zA-Z0-9_]+$
@@ -2590,6 +2601,8 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the cover letter in mbox format.
           type: string
           format: uri
           readOnly: true
@@ -2633,6 +2646,10 @@ components:
           minLength: 1
         mbox:
           title: Mbox
+          description: |
+            A URL to download the patch in mbox format. Add the `series=*`
+            querystring parameter to include series dependencies in the mbox
+            file.
           type: string
           format: uri
           readOnly: true
@@ -2759,7 +2776,7 @@ components:
           readOnly: true
         name:
           title: Name
-          description: >
+          description: |
             An optional name to associate with the series, e.g. "John's PCI
             series".
           readOnly: true
@@ -2777,12 +2794,14 @@ components:
           readOnly: true
         version:
           title: Version
-          description: >
+          description: |
             Version of series as indicated by the subject prefix(es).
           type: integer
           readOnly: true
         mbox:
           title: Mbox
+          description: |
+            A URL to download the series in mbox format.
           type: string
           format: uri
           readOnly: true