Merge branch 'RESTAPI-1020-deprecating-reservations' into 'master'

Mark reservations as deprecated See merge request firecrest/firecrest!284
eth-cscs · Mar 25, 2024 · 6b2133b · 6b2133b
2 parents 0a3dbf2 + 22761ec
commit 6b2133b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 8 deletions.
diff --git a/deploy/demo/kong/kong.yml b/deploy/demo/kong/kong.yml
@@ -43,6 +43,11 @@ plugins:
     - Content-Type
     credentials: false
     max_age: 3600
+- name: response-transformer
+  route: reservations
+  config:
+    add:
+      headers: ["Deprecation:@1711111630", "Sunset:Only suppoerted until v2.0"]
 
 consumers:
 - jwt_secrets:

diff --git a/doc/openapi/firecrest-api.yaml b/doc/openapi/firecrest-api.yaml
@@ -2181,8 +2181,9 @@ paths:
         schema:
           type: string
     get:
-      summary: Returns all reservations
+      summary: "[Warning: only supported until v1.17.0] Returns all reservations"
       description: List all active reservations and their status
+      deprecated: true
       tags:
         - Reservation
       responses:
@@ -2227,8 +2228,9 @@ paths:
                 type: integer
 
     post:
-      summary: Creates a new reservation
+      summary: "[Warning: only supported until v1.17.0] Creates a new reservation"
       description: Creates a new reservation with {reservation} name for a given SLURM groupname
+      deprecated: true
       tags:
         - Reservation
       requestBody:
@@ -2342,8 +2344,9 @@ paths:
         schema:
           type: string
     put:
-      summary: Updates reservation {reservation}
+      summary: "[Warning: only supported until v1.17.0] Updates reservation {reservation}"
       description: Updates an already created reservation named {reservation}
+      deprecated: true
       tags:
         - Reservation
       requestBody:
@@ -2437,8 +2440,9 @@ paths:
                 type: integer
 
     delete:
-      summary: Deletes reservation {reservation}
+      summary: "[Warning: only supported until v1.17.0] Deletes reservation {reservation}"
       description: Deletes an already created reservation named {reservation}
+      deprecated: true
       tags:
         - Reservation
       responses:

diff --git a/doc/openapi/firecrest-developers-api.yaml b/doc/openapi/firecrest-developers-api.yaml
@@ -2319,8 +2319,9 @@ paths:
         schema:
           type: string
     get:
-      summary: Returns all reservations
+      summary: "[Warning: only supported until v1.17.0] Returns all reservations"
       description: List all active reservations and their status
+      deprecated: true
       tags:
         - Reservation
       responses:
@@ -2365,8 +2366,9 @@ paths:
                 type: integer
 
     post:
-      summary: Creates a new reservation
+      summary: "[Warning: only supported until v1.17.0] Creates a new reservation"
       description: Creates a new reservation with {reservation} name for a given SLURM groupname
+      deprecated: true
       tags:
         - Reservation
       requestBody:
@@ -2480,8 +2482,9 @@ paths:
         schema:
           type: string
     put:
-      summary: Updates reservation {reservation}
+      summary: "[Warning: only supported until v1.17.0] Updates reservation {reservation}"
       description: Updates an already created reservation named {reservation}
+      deprecated: true
       tags:
         - Reservation
       requestBody:
@@ -2575,8 +2578,9 @@ paths:
                 type: integer
 
     delete:
-      summary: Deletes reservation {reservation}
+      summary: "[Warning: only supported until v1.17.0] Deletes reservation {reservation}"
       description: Deletes an already created reservation named {reservation}
+      deprecated: true
       tags:
         - Reservation
       responses: