Merge pull request RedHatInsights#1174 from vbelchio/trailing_slashes

Adding trailing slashes in the Workspaces endpoints
petracihalova · Aug 28, 2024 · a31343c · a31343c
2 parents 59854c1 + 9d52dac
commit a31343c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 12 deletions.
diff --git a/docs/source/specs/typespec/main.tsp b/docs/source/specs/typespec/main.tsp
@@ -39,17 +39,17 @@ namespace Problems {
     model ProblemDetails<Status extends valueof int16> {
         @header("content-type") contentType: "application/problem+json";
         type?: ProblemType;
-    
+
         @statusCode _: typeof Status;
         status?: typeof Status;
-        
+
         title?: string;
         detail?: string;
 
         @format("uri")
         instance?: string;
     }
-  
+
     @error
     model Problem403 extends ProblemDetails<Status = 403>{
         type: ProblemType.InsufficientPermission,
@@ -64,7 +64,7 @@ namespace Problems {
         @example("Not found")
         detail: string
     }
-    
+
     alias Problem500 = ProblemDetails<Status = 500>;
 
     @error
@@ -75,7 +75,7 @@ namespace Problems {
     }
 
     alias Problem400AlreadyExists = ProblemDetails<Status = 400>;
-    
+
     alias CommonProblems = Problem401 | Problem403 | Problem500;
 
     namespace Workspace {
@@ -85,10 +85,10 @@ namespace Problems {
     }
 }
 
-@route("/workspaces")
+@route("/workspaces/")
 @tag("Workspaces")
 @doc("Operations about workspaces")
-namespace Workspaces {    
+namespace Workspaces {
     model BasicWorkspace {
         @doc("Workspace A")
         name: string = "Workspace A";
@@ -139,26 +139,29 @@ namespace Workspaces {
         @statusCode
         statusCode: 204,
     }
-   
+
     @doc("Create workspace in tenant")
     @summary("Create workspace in tenant")
     @post op create(@body body: CreateWorkspaceRequest): CreateWorkspaceResponse | Problems.CommonProblems | Problems.Problem400;
 
     @doc("Get a workspace in tenant")
     @summary("Get a workspace in tenant")
+    @route("{uuid}/")
     @get op read(
         @doc("Unique identification")
         @path uuid: UUID;
     ): ReadWorkspaceResponse | Problems.CommonProblems | Problems.Problem404;
 
     @doc("Edit a workspace")
     @summary("Edit the workspace name or description")
+    @route("{uuid}/")
     @put op update(
         @doc("Unique identification")
         @path uuid: UUID;
         @body body: UpdateWorkspaceRequest
     ): UpdateWorkspaceResponse | Problems.CommonProblems | Problems.Problem400AlreadyExists ;
 
+    @route("{uuid}/")
     @patch op patch(
         @doc("Unique identification")
         @path uuid: UUID;
@@ -167,6 +170,7 @@ namespace Workspaces {
 
     @doc("Delete a workspace")
     @summary("Delete the workspace")
+    @route("{uuid}/")
     @delete op delete(
         @doc("Unique identification")
         @path uuid: UUID;

diff --git a/docs/source/specs/v2/openapi.v2.yaml b/docs/source/specs/v2/openapi.v2.yaml
@@ -5,7 +5,7 @@ info:
 tags:
   - name: Workspaces
 paths:
-  /workspaces:
+  /workspaces/:
     post:
       tags:
         - Workspaces
@@ -78,7 +78,7 @@ paths:
           application/json:
             schema:
               $ref: '#/components/schemas/Workspaces.BasicWorkspace'
-  /workspaces/{uuid}:
+  /workspaces/{uuid}/:
     get:
       tags:
         - Workspaces
@@ -256,7 +256,7 @@ paths:
             $ref: '#/components/schemas/UUID'
       responses:
         '200':
-          description: 'There is no content to send for this request, but the headers may be useful. '
+          description: The request has succeeded.
           content:
             application/json:
               schema:
@@ -348,7 +348,7 @@ paths:
             $ref: '#/components/schemas/UUID'
       responses:
         '204':
-          description: The request has succeeded and the resource has been deleted.
+          description: 'There is no content to send for this request, but the headers may be useful. '
         '400':
           description: The server could not understand the request due to invalid syntax.
           content: