refactor: improve api schema

packages/api/src/schema/api-schema.yaml

@@ -176,6 +176,15 @@ components:
         name:
           type: string
           example: test_webhook
+        kind:
+          type: string
+          example: webhook
+          readOnly: true
+          deprecated: true
+        userId:
+          type: string
+          readOnly: true
+          deprecated: true
         projectId:
           type: string
           description: The ID of the project
@@ -452,6 +461,7 @@ components:
         kind:
           type: string
           example: stream
+          deprecated: true
         creatorId:
           $ref: "#/components/schemas/creator-id"
         userTags:
@@ -548,18 +558,14 @@ components:
               example:
                 Authorization: "Bearer 123"
             isMobile:
-              type:
-                - boolean
-                - integer
+              type: integer
               enum:
-                - false
-                - true
                 - 0
                 - 1
                 - 2
               description: |-
                 If true, the stream will be pulled from a mobile source.
-              default: false
+              default: 0
             location:
               type: object
               description: |-
@@ -591,7 +597,9 @@ components:
         playbackPolicy:
           $ref: "#/components/schemas/playback-policy"
         profiles:
-          type: array
+          type:
+            - array
+            - "null"
           default:
             - name: 240p0
               fps: 0
@@ -651,7 +659,9 @@ components:
             Timestamp (in milliseconds) when the stream was last terminated
         userId:
           type: string
+          readOnly: true
           example: "we7818e7-610a-4057-8f6f-b785dc1e6f88"
+          deprecated: true
         renditions:
           type: object
     new-stream-payload:
@@ -735,21 +745,25 @@ components:
           type: boolean
           description: Indicates whether the stream is currently live or not.
         is_healthy:
-          type: boolean
-          description: Indicates whether the stream is healthy or not.
+          oneOf:
+            - type: "null"
+            - type: "boolean"
+          description: "Indicates whether the stream is healthy or not."
         issues:
-          type: string
+          oneOf:
+            - type: "null"
+            - type: "string"
           description: |
-            Raw issues affecting the stream as described by Mist, if any. We
-            don't expose those to the end-user, showing only human_issues
-            instead.
+            "Raw issues affecting the stream as described by Mist, if any. We don't expose those to the end-user, showing only human_issues instead."
         human_issues:
-          type: array
-          description: |
-            A string array of human-readable errors describing issues affecting
-            the stream, if any.
-          items:
-            type: string
+          oneOf:
+            - type: "null"
+            - type: "array"
+              items:
+                type: "string"
+          description:
+            "A string array of human-readable errors describing issues affecting
+            the stream, if any."
         tracks:
           type: object
           description: |
@@ -801,6 +815,15 @@ components:
           type: string
           readOnly: true
           example: de7818e7-610a-4057-8f6f-b785dc1e6f88
+        kind:
+          type: string
+          example: stream
+          deprecated: true
+        userId:
+          type: string
+          readOnly: true
+          example: 66E2161C-7670-4D05-B71D-DA2D6979556F
+          deprecated: true
         name:
           type: string
           example: test_session
@@ -889,8 +912,6 @@ components:
           items:
             $ref: "#/components/schemas/ffmpeg-profile"
     error:
-      required:
-        - errors
       type: object
       properties:
         errors:
@@ -913,6 +934,11 @@ components:
           example: 09F8B46C-61A0-4254-9875-F71F4C605BC7
         name:
           type: string
+        userId:
+          type: string
+          readOnly: true
+          example: 66E2161C-7670-4D05-B71D-DA2D6979556F
+          deprecated: true
         url:
           type: string
           writeOnly: true
@@ -958,6 +984,11 @@ components:
           description: >-
             The playback ID to use with the Playback Info endpoint to retrieve
             playback URLs.
+        userId:
+          type: string
+          readOnly: true
+          example: 66E2161C-7670-4D05-B71D-DA2D6979556F
+          deprecated: true
         staticMp4:
           type: boolean
           writeOnly: true
@@ -1327,7 +1358,9 @@ components:
           type: boolean
           description: Decides if the output video should include C2PA signature
         profiles:
-          type: array
+          type:
+            - array
+            - "null"
           items:
             $ref: "#/components/schemas/transcode-profile"
         targetSegmentSizeSecs:
@@ -2096,6 +2129,11 @@ components:
           type: string
           description: Name of the signing key
           example: key1
+        userId:
+          type: string
+          readOnly: true
+          example: 78df0075-b5f3-4683-a618-1086faca35dc
+          deprecated: true
         createdAt:
           readOnly: true
           type: number
@@ -2226,7 +2264,9 @@ components:
           type: number
           example: 200000
     playback-policy:
-      type: object
+      type:
+        - object
+        - "null"
       description:
         Whether the playback policy for a asset or stream is public or signed
       additionalProperties: false
@@ -2259,17 +2299,12 @@ components:
       type: object
       description: |
         An individual metric about usage of a user.
-      required:
-        - UserID
-        - CreatorID
-        - DeliveryUsageMins
-        - TotalUsageMins
-        - StorageUsageMins
       properties:
         UserID:
           type: string
           description: The user ID associated with the metric
           example: 1bde4o2i6xycudoy
+
         CreatorID:
           type: string
           description: The creator ID associated with the metric
@@ -2412,7 +2447,7 @@ components:
             - source
           properties:
             live:
-              type: number
+              type: integer
               enum:
                 - 0
                 - 1
@@ -2968,9 +3003,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: "#/components/schemas/multistream-target"
+                $ref: "#/components/schemas/multistream-target"
                 x-speakeasy-name-override: data
         default:
           description: Error
@@ -3078,6 +3111,12 @@ paths:
         To create a new webhook, you need to make an API call with the events
         you want to listen for and the URL that will be called when those events
         occur.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/webhook"
       responses:
         "200":
           description: Success
@@ -3131,6 +3170,12 @@ paths:
       operationId: updateWebhook
       tags:
         - webhook
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/webhook"
       responses:
         "200":
           description: Success
@@ -4193,9 +4238,6 @@ paths:
                 description: |
                   A simplified metric object about aggregate viewership of an
                   asset. Either playbackId or dStorageUrl will be set.
-                required:
-                  - viewCount
-                  - playtimeMins
                 properties:
                   playbackId:
                     $ref: >-

packages/api/src/schema/db-schema.yaml

@@ -586,13 +586,7 @@ components:
     webhook:
       table: webhook
       properties:
-        kind:
-          type: string
-          example: webhook
-          readOnly: true
         userId:
-          readOnly: true
-          type: string
           index: true
         projectId:
           type: string
@@ -894,15 +888,11 @@ components:
       table: session
       properties:
         kind:
-          type: string
-          example: stream
           readOnly: true
         version:
           type: string
           description: Version of the session object
         userId:
-          type: string
-          example: 66E2161C-7670-4D05-B71D-DA2D6979556F
           index: true
         lastSeen:
           index: true
@@ -928,9 +918,6 @@ components:
       table: multistream_target
       properties:
         userId:
-          type: string
-          example: 66E2161C-7670-4D05-B71D-DA2D6979556F
-          readOnly: true
           index: true
     asset:
       table: asset
@@ -940,11 +927,7 @@ components:
         playbackId:
           index: true
         userId:
-          readOnly: true
           index: true
-          type: string
-          example: 66E2161C-7670-4D05-B71D-DA2D6979556F
-          description: owner of the asset
         source:
           oneOf:
             - properties:
@@ -1076,20 +1059,6 @@ components:
           type: number
           description: Timestamp (in milliseconds) at which the stream started.
           example: 1587667174725
-    webhook-patch-payload:
-      type: object
-      additionalProperties: false
-      properties:
-        name:
-          $ref: "#/components/schemas/webhook/properties/name"
-        url:
-          $ref: "#/components/schemas/webhook/properties/url"
-        events:
-          $ref: "#/components/schemas/webhook/properties/events"
-        sharedSecret:
-          $ref: "#/components/schemas/webhook/properties/sharedSecret"
-        streamId:
-          $ref: "#/components/schemas/webhook/properties/streamId"
     ipfs-file-info:
       properties:
         cid:
@@ -1314,10 +1283,7 @@ components:
         id:
           index: true
         userId:
-          readOnly: true
           index: true
-          type: string
-          example: 78df0075-b5f3-4683-a618-1086faca35dc
         deleted:
           type: boolean
           default: false
@@ -1396,3 +1362,17 @@ components:
           example: 09F8B46C-61A0-4254-9875-F71F4C605BC7
         catalystPipelineStrategy:
           $ref: "#/components/schemas/task/properties/params/properties/upload/properties/catalystPipelineStrategy"
+    webhook-patch-payload:
+      type: object
+      additionalProperties: false
+      properties:
+        name:
+          $ref: "#/components/schemas/webhook/properties/name"
+        url:
+          $ref: "#/components/schemas/webhook/properties/url"
+        events:
+          $ref: "#/components/schemas/webhook/properties/events"
+        sharedSecret:
+          $ref: "#/components/schemas/webhook/properties/sharedSecret"
+        streamId:
+          $ref: "#/components/schemas/webhook/properties/streamId"

packages/www/pages/app/stream/[id].tsx

@@ -258,8 +258,9 @@ const ID = () => {
       } else if ("errors" in info) {
         throw new Error(info.errors.toString());
       }
-      setStream(info.stream);
-      setStreamOwner(info.user);
+
+      setStream(info.stream as Stream);
+      setStreamOwner(info.user as User);
     } catch (err) {
       console.error(err); // todo: surface this
     }