[RTC-218/219] Fix OpenApi bugs (fishjam-dev#31)

BryanJBryce · Apr 17, 2023 · 6f020be · 6f020be
1 parent 3aa3c4e
commit 6f020be
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 13 deletions.
diff --git a/lib/jellyfish_web/api_spec/component.ex b/lib/jellyfish_web/api_spec/component.ex
@@ -40,6 +40,7 @@ defmodule JellyfishWeb.ApiSpec.Component do
     properties: %{
       id: %Schema{type: :string, description: "Assigned component id", example: "component-1"},
       type: Type
-    }
+    },
+    required: [:id, :type]
   })
 end
diff --git a/lib/jellyfish_web/api_spec/error.ex b/lib/jellyfish_web/api_spec/error.ex
@@ -14,6 +14,7 @@ defmodule JellyfishWeb.ApiSpec.Error do
         description: "Error details",
         example: "Token has expired"
       }
-    }
+    },
+    required: [:errors]
   })
 end
diff --git a/lib/jellyfish_web/api_spec/peer.ex b/lib/jellyfish_web/api_spec/peer.ex
@@ -52,8 +52,8 @@ defmodule JellyfishWeb.ApiSpec.Peer do
     properties: %{
       id: %Schema{type: :string, description: "Assigned peer id", example: "peer-1"},
       type: Type,
-      status: Status,
-      token: Token
-    }
+      status: Status
+    },
+    required: [:id, :type, :status]
   })
 end
diff --git a/lib/jellyfish_web/api_spec/responses.ex b/lib/jellyfish_web/api_spec/responses.ex
@@ -1,5 +1,10 @@
 [
-  {PeerDetailsResponse, "Response containing peer details", JellyfishWeb.ApiSpec.Peer},
+  {PeerDetailsResponse, "Response containing peer details and their token",
+   %OpenApiSpex.Schema{
+     type: :object,
+     properties: %{peer: JellyfishWeb.ApiSpec.Peer, token: JellyfishWeb.ApiSpec.Peer.Token},
+     required: [:peer, :token]
+   }},
   {RoomDetailsResponse, "Response containing room details", JellyfishWeb.ApiSpec.Room},
   {ComponentDetailsResponse, "Response containing component details",
    JellyfishWeb.ApiSpec.Component},

diff --git a/lib/jellyfish_web/api_spec/room.ex b/lib/jellyfish_web/api_spec/room.ex
@@ -40,6 +40,7 @@ defmodule JellyfishWeb.ApiSpec.Room do
         type: :array,
         items: Peer
       }
-    }
+    },
+    required: [:id, :config, :components, :peers]
   })
 end
diff --git a/lib/jellyfish_web/controllers/peer_controller.ex b/lib/jellyfish_web/controllers/peer_controller.ex
@@ -47,7 +47,7 @@ defmodule JellyfishWeb.PeerController do
         description: "Room ID",
         type: :string
       ],
-      peer_id: [
+      id: [
         in: :path,
         description: "Peer id",
         type: :string

diff --git a/openapi.yaml b/openapi.yaml
@@ -17,6 +17,9 @@ components:
           type: string
         type:
           $ref: '#/components/schemas/ComponentType'
+      required:
+        - id
+        - type
       title: Component
       type: object
       x-struct: Elixir.JellyfishWeb.ApiSpec.Component
@@ -50,6 +53,8 @@ components:
           description: Error details
           example: Token has expired
           type: string
+      required:
+        - errors
       title: Error
       type: object
       x-struct: Elixir.JellyfishWeb.ApiSpec.Error
@@ -62,18 +67,28 @@ components:
           type: string
         status:
           $ref: '#/components/schemas/PeerStatus'
-        token:
-          $ref: '#/components/schemas/AuthToken'
         type:
           $ref: '#/components/schemas/PeerType'
+      required:
+        - id
+        - type
+        - status
       title: Peer
       type: object
       x-struct: Elixir.JellyfishWeb.ApiSpec.Peer
     PeerDetailsResponse:
-      description: Response containing peer details
+      description: Response containing peer details and their token
       properties:
         data:
-          $ref: '#/components/schemas/Peer'
+          properties:
+            peer:
+              $ref: '#/components/schemas/Peer'
+            token:
+              $ref: '#/components/schemas/AuthToken'
+          required:
+            - peer
+            - token
+          type: object
       required:
         - data
       title: PeerDetailsResponse
@@ -111,6 +126,11 @@ components:
           items:
             $ref: '#/components/schemas/Peer'
           type: array
+      required:
+        - id
+        - config
+        - components
+        - peers
       title: Room
       type: object
       x-struct: Elixir.JellyfishWeb.ApiSpec.Room
@@ -430,7 +450,7 @@ paths:
             type: string
         - description: Peer id
           in: path
-          name: peer_id
+          name: id
           required: true
           schema:
             type: string