urls: Create endpoint to link two series

Closes getpatchwork#506 Signed-off-by: andrepapoti <[email protected]>
andrepapoti · Mar 18, 2024 · beaab2c · beaab2c
1 parent 437d9c3
commit beaab2c
Show file tree

Hide file tree

Showing 6 changed files with 3,428 additions and 3 deletions.
diff --git a/docs/api/schemas/generate-schemas.py b/docs/api/schemas/generate-schemas.py
@@ -14,8 +14,8 @@
     yaml = None
 
 ROOT_DIR = os.path.dirname(os.path.realpath(__file__))
-VERSIONS = [(1, 0), (1, 1), (1, 2), (1, 3), None]
-LATEST_VERSION = (1, 3)
+VERSIONS = [(1, 0), (1, 1), (1, 2), (1, 3), (1, 4), None]
+LATEST_VERSION = (1, 4)
 
 
 def generate_schemas():

diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
@@ -13,7 +13,7 @@ info:
   license:
     name: GPL v2 License
     url: https://www.gnu.org/licenses/gpl-2.0.html
-  version: '1.3'
+  version: '1.4'
 paths:
   /api:
     get:
@@ -1223,6 +1223,56 @@ paths:
                 $ref: '#/components/schemas/Error'
       tags:
         - series
+  /api/series/{id}/link/{related_series_id}:
+    parameters:
+      - in: path
+        name: id
+        description: A unique integer value identifying this series.
+        required: true
+        schema:
+          title: Series ID
+          type: integer
+      - in: path
+        name: related_series_id
+        description: A unique integer value identifying the related series.
+        required: true
+        schema:
+          title: Related series ID
+          type: integer
+    patch:
+      summary: Link both series.
+      description: |
+        Link two series makes so that they bidirectionaly relate to each other.
+
+        Series must belong to the same project to be able to be linked
+      operationId: series_link
+      responses:
+        '200':
+          description: 'Liked series'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Series'
+        '400':
+          description: 'Bad request'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: 'Forbidden'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '404':
+          description: 'Not found'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      tags:
+        - series
   /api/users:
     get:
       summary: List users.
@@ -2605,6 +2655,13 @@ components:
             $ref: '#/components/schemas/PatchEmbedded'
           readOnly: true
           uniqueItems: true
+        related_series:
+          title: Related series
+          type: array
+          items:
+            $ref: '#/components/schemas/Series'
+          readOnly: true
+          uniqueItems: true
     User:
       type: object
       title: User

diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
@@ -1248,6 +1248,58 @@ paths:
                 $ref: '#/components/schemas/Error'
       tags:
         - series
+{% if version >= (1, 4) %}
+  /api/{{ version_url }}series/{id}/link/{related_series_id}:
+    parameters:
+      - in: path
+        name: id
+        description: A unique integer value identifying this series.
+        required: true
+        schema:
+          title: Series ID
+          type: integer
+      - in: path
+        name: related_series_id
+        description: A unique integer value identifying the related series.
+        required: true
+        schema:
+          title: Related series ID
+          type: integer
+    patch:
+      summary: Link both series.
+      description: |
+        Link two series makes so that they bidirectionaly relate to each other.
+
+        Series must belong to the same project to be able to be linked
+      operationId: series_link
+      responses:
+        '200':
+          description: 'Liked series'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Series'
+        '400':
+          description: 'Bad request'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: 'Forbidden'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '404':
+          description: 'Not found'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      tags:
+        - series
+{% endif %}
   /api/{{ version_url }}users:
     get:
       summary: List users.
@@ -2699,6 +2751,15 @@ components:
             $ref: '#/components/schemas/PatchEmbedded'
           readOnly: true
           uniqueItems: true
+{% if version >= (1, 4) %}
+        related_series:
+          title: Related series
+          type: array
+          items:
+            $ref: '#/components/schemas/Series'
+          readOnly: true
+          uniqueItems: true
+{% endif %}
     User:
       type: object
       title: User