From 36ea72bd8cc769421b8b683acbecd62a04cdf93a Mon Sep 17 00:00:00 2001 From: Elia Palme Date: Fri, 22 Mar 2024 14:49:11 +0100 Subject: [PATCH 1/2] Mark reservations as deprecated --- deploy/demo/kong/kong.yml | 5 +++++ doc/openapi/firecrest-api.yaml | 12 ++++++++---- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/deploy/demo/kong/kong.yml b/deploy/demo/kong/kong.yml index b2ea67fa..0e504cc5 100644 --- 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 index 033c64be..e2c4f82b 100644 --- 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 v2.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 v2.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 v2.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 v2.0] Deletes reservation {reservation}" description: Deletes an already created reservation named {reservation} + deprecated: true tags: - Reservation responses: From 22761ec9f5e7d851fc3c1b2444e58778af4f6e0b Mon Sep 17 00:00:00 2001 From: Elia Palme Date: Mon, 25 Mar 2024 10:04:17 +0100 Subject: [PATCH 2/2] Updated deprecation massage --- doc/openapi/firecrest-api.yaml | 8 ++++---- doc/openapi/firecrest-developers-api.yaml | 12 ++++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/doc/openapi/firecrest-api.yaml b/doc/openapi/firecrest-api.yaml index e2c4f82b..2e0c7535 100644 --- a/doc/openapi/firecrest-api.yaml +++ b/doc/openapi/firecrest-api.yaml @@ -2181,7 +2181,7 @@ paths: schema: type: string get: - summary: "[Warning: only supported until v2.0] 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: @@ -2228,7 +2228,7 @@ paths: type: integer post: - summary: "[Warning: only supported until v2.0] 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: @@ -2344,7 +2344,7 @@ paths: schema: type: string put: - summary: "[Warning: only supported until v2.0] 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: @@ -2440,7 +2440,7 @@ paths: type: integer delete: - summary: "[Warning: only supported until v2.0] 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: diff --git a/doc/openapi/firecrest-developers-api.yaml b/doc/openapi/firecrest-developers-api.yaml index c8124948..346fc989 100644 --- 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: