Merge branch 'main' into philipn-timestamp-def

bbc · Jan 2, 2025 · da4f8cd · da4f8cd
2 parents d69c00f + 7393bb3
commit da4f8cd
Show file tree

Hide file tree

Showing 10 changed files with 506 additions and 13 deletions.
diff --git a/api/TimeAddressableMediaStore.yaml b/api/TimeAddressableMediaStore.yaml
@@ -1236,8 +1236,9 @@ paths:
           description: ""
           content:
             application/json:
-              example:
-                $ref: examples/flow-read-only-get-200.json
+              example: true
+              schema:
+                type: boolean
         "404":
           description: The requested flow does not exist.
     put:
@@ -1249,8 +1250,7 @@ paths:
       requestBody:
         content:
           application/json:
-            example:
-              $ref: examples/flow-read-only-put.json
+            example: true
             schema:
               type: boolean
         required: true
@@ -1261,6 +1261,222 @@ paths:
           description: Bad request. Invalid flow read_only value. Value must be boolean.
         "404":
           description: The requested flow does not exist.
+  /flows/{flowId}/flow_collection:
+    parameters:
+      - name: flowId
+        in: path
+        required: true
+        schema:
+          $ref: '#/components/schemas/uuid'
+        description: The flow identifier.
+    head:
+      summary: Flow Collection
+      description: Returns the flow collection path headers
+      operationId: HEAD_flows-flowId-flow-collection
+      tags:
+        - Flows
+      responses:
+        "200":
+          $ref: '#/components/responses/trait_resource_info_head_200'
+        "404":
+          $ref: '#/components/responses/trait_resource_info_head_404'
+    get:
+      summary: Flow Collection
+      description: Returns the flow collection property.
+      operationId: GET_flows-flowId-flow-collection
+      tags:
+        - Flows
+      responses:
+        "200":
+          description: ""
+          content:
+            application/json:
+              example:
+                $ref: examples/flow-collection-get-200.json
+              schema:
+                $ref: schemas/flow-collection.json
+        "404":
+          description: The requested flow does not exist.
+    put:
+      summary: Create or Update Flow Collection
+      description: Create or update the flow collection property.
+      operationId: PUT_flows-flowId-flow-collection
+      tags:
+        - Flows
+      requestBody:
+        content:
+          application/json:
+            example:
+              $ref: examples/flow-collection-put.json
+            schema:
+              $ref: schemas/flow-collection.json
+        required: true
+      responses:
+        "204":
+          description: No content. The flow collection has been created or updated.
+        "400":
+          description: Bad request. Invalid flow collection.
+        "403":
+          description: Forbidden. You do not have permission to modify this flow. It may be marked read-only.
+        "404":
+          description: The requested flow does not exist.
+    delete:
+      summary: Delete Flow Collection
+      description: Delete the flow collection property.
+      operationId: DELETE_flows-flowId-flow-collection
+      tags:
+        - Flows
+      responses:
+        "204":
+          description: No content. The flow collection property has been deleted.
+        "403":
+          description: Forbidden. You do not have permission to modify this flow. It may be marked read-only.
+        "404":
+          description: The requested flow ID in the path is invalid.
+  /flows/{flowId}/max_bit_rate:
+    parameters:
+      - name: flowId
+        in: path
+        required: true
+        schema:
+          $ref: '#/components/schemas/uuid'
+        description: The flow identifier.
+    head:
+      summary: Flow Maximum Bit Rate
+      description: Returns the flow max bit rate path headers
+      operationId: HEAD_flows-flowId-max-bit-rate
+      tags:
+        - Flows
+      responses:
+        "200":
+          $ref: '#/components/responses/trait_resource_info_head_200'
+        "404":
+          $ref: '#/components/responses/trait_resource_info_head_404'
+    get:
+      summary: Flow Maximum Bit Rate
+      description: Returns the flow max bit rate property.
+      operationId: GET_flows-flowId-max-bit-rate
+      tags:
+        - Flows
+      responses:
+        "200":
+          description: ""
+          content:
+            application/json:
+              example: 5000
+              schema:
+                type: integer
+                minimum: 0
+        "404":
+          description: The requested flow does not exist.
+    put:
+      summary: Create or Update Flow Maximum Bit Rate
+      description: Create or update the max bit rate property.
+      operationId: PUT_flows-flowId-max-bit-rate
+      tags:
+        - Flows
+      requestBody:
+        content:
+          application/json:
+            example: 5000
+            schema:
+              type: integer
+              minimum: 0
+        required: true
+      responses:
+        "204":
+          description: No content. The max bit rate has been created or updated.
+        "400":
+          description: Bad request. Invalid flow max bit rate.
+        "403":
+          description: Forbidden. You do not have permission to modify this flow. It may be marked read-only.
+        "404":
+          description: The requested flow does not exist.
+    delete:
+      summary: Delete Flow Maximum Bit Rate
+      description: Delete the flow max bit rate property.
+      operationId: DELETE_flows-flowId-max-bit-rate
+      tags:
+        - Flows
+      responses:
+        "204":
+          description: No content. The flow max bit rate property has been deleted.
+        "403":
+          description: Forbidden. You do not have permission to modify this flow. It may be marked read-only.
+        "404":
+          description: The requested flow ID in the path is invalid.
+  /flows/{flowId}/avg_bit_rate:
+    parameters:
+      - name: flowId
+        in: path
+        required: true
+        schema:
+          $ref: '#/components/schemas/uuid'
+        description: The flow identifier.
+    head:
+      summary: Flow Average Bit Rate
+      description: Returns the flow average bit rate path headers
+      operationId: HEAD_flows-flowId-avg-bit-rate
+      tags:
+        - Flows
+      responses:
+        "200":
+          $ref: '#/components/responses/trait_resource_info_head_200'
+        "404":
+          $ref: '#/components/responses/trait_resource_info_head_404'
+    get:
+      summary: Flow Average Bit Rate
+      description: Returns the flow average bit rate property.
+      operationId: GET_flows-flowId-avg-bit-rate
+      tags:
+        - Flows
+      responses:
+        "200":
+          description: ""
+          content:
+            application/json:
+              example: 3246
+              schema:
+                type: integer
+                minimum: 0
+        "404":
+          description: The requested flow does not exist.
+    put:
+      summary: Create or Update Flow Average Bit Rate
+      description: Create or update the average bit rate property.
+      operationId: PUT_flows-flowId-avg-bit-rate
+      tags:
+        - Flows
+      requestBody:
+        content:
+          application/json:
+            example: 3246
+            schema:
+              type: integer
+              minimum: 0
+        required: true
+      responses:
+        "204":
+          description: No content. The average bit rate has been created or updated.
+        "400":
+          description: Bad request. Invalid flow avg bit rate.
+        "403":
+          description: Forbidden. You do not have permission to modify this flow. It may be marked read-only.
+        "404":
+          description: The requested flow does not exist.
+    delete:
+      summary: Delete Flow Average Bit Rate
+      description: Delete the flow average bit rate property.
+      operationId: DELETE_flows-flowId-avg-bit-rate
+      tags:
+        - Flows
+      responses:
+        "204":
+          description: No content. The flow average bit rate property has been deleted.
+        "403":
+          description: Forbidden. You do not have permission to modify this flow. It may be marked read-only.
+        "404":
+          description: The requested flow ID in the path is invalid.
   /flows/{flowId}/segments:
     parameters:
       - name: flowId

diff --git a/api/examples/flow-collection-get-200.json b/api/examples/flow-collection-get-200.json
@@ -0,0 +1,14 @@
+[
+    {
+        "id": "4f79cfd1-c057-47f4-8e4d-1b126ca7bf34",
+        "role": "video"
+    },
+    {
+        "id": "6101df05-06bb-41b8-8af4-cf7cd33df209",
+        "role": "audio"
+    },
+    {
+        "id": "e85efab4-993b-4ad6-9af3-4cd8d0d38860",
+        "role": "subtitles"
+    }
+]
diff --git a/api/examples/flow-collection-put.json b/api/examples/flow-collection-put.json
@@ -0,0 +1,14 @@
+[
+    {
+        "id": "4f79cfd1-c057-47f4-8e4d-1b126ca7bf34",
+        "role": "video"
+    },
+    {
+        "id": "6101df05-06bb-41b8-8af4-cf7cd33df209",
+        "role": "audio"
+    },
+    {
+        "id": "e85efab4-993b-4ad6-9af3-4cd8d0d38860",
+        "role": "subtitles"
+    }
+]
diff --git a/api/examples/flow-read-only-get-200.json b/api/examples/flow-read-only-get-200.json
diff --git a/api/examples/flow-read-only-put.json b/api/examples/flow-read-only-put.json
diff --git a/api/schemas/flow-collection.json b/api/schemas/flow-collection.json
@@ -0,0 +1,7 @@
+{
+    "title": "Flow Collection",
+    "type": "array",
+    "items": {
+        "$ref": "collection-item.json"
+    }
+}
diff --git a/api/schemas/flow-core.json b/api/schemas/flow-core.json
@@ -89,11 +89,8 @@
       "$ref": "timerange.json"
     },
     "flow_collection": {
-        "type": "array",
         "description": "List of Flows that are collected together by this Flow.",
-        "items": {
-            "$ref": "collection-item.json"
-        }
+        "$ref": "flow-collection.json"
     },
     "collected_by": {
       "type": "array",

diff --git a/docs/README.md b/docs/README.md
@@ -30,6 +30,7 @@ For more information on how we use ADRs, see [here](./adr/README.md).
 | [0018](./adr/0018-restrict-direct-source-modification.md)          | Restrict direct Source modification                                        |
 | [0019](./adr/0019-consolidate-modified-updated-terms.md)           | Rename `modified_by` properties in Source and Flow schemas to `updated_by` |
 | [0020](./adr/0020-version-signalling.md)                           | Improving the signalling of the supported API version in implementations   |
+| [0025](./adr/0025-flow-property-updates.md)                        | Options for updating Flow properties                                       |
 
 \* Note: ADR 0004a was the unintended result of a number clash in the early development of TAMS which wasn't caught before publication