api: add accept_get_urls query option for /segments endpoint

bbc · Sep 17, 2024 · 84cbe85 · 84cbe85
1 parent 4f477c4
commit 84cbe85
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/api/TimeAddressableMediaStore.yaml b/api/TimeAddressableMediaStore.yaml
@@ -1290,6 +1290,15 @@ paths:
           schema:
             default: false
             type: boolean
+        - name: accept_get_urls
+          in: query
+          description: |
+            A comma separated list of labels of flow segment `get_urls` to include in the response.
+            A 'default' label selects URLs with a 'default' or no label.
+            An empty `accept_get_urls` results in an empty or no `get_urls` flow segment property in the response.
+          schema:
+            type: string
+            pattern: ^[^,]*(,[^,]*)*$
         - $ref: '#/components/parameters/trait_resource_paged_key'
         - $ref: '#/components/parameters/trait_paged_limit'
       responses:
@@ -1380,6 +1389,15 @@ paths:
           schema:
             default: false
             type: boolean
+        - name: accept_get_urls
+          in: query
+          description: |
+            A comma separated list of labels of flow segment `get_urls` to include in the response.
+            A 'default' label selects URLs with a 'default' or no label.
+            An empty `accept_get_urls` results in an empty or no `get_urls` flow segment property in the response.
+          schema:
+            type: string
+            pattern: ^[^,]*(,[^,]*)*$
         - $ref: '#/components/parameters/trait_resource_paged_key'
         - $ref: '#/components/parameters/trait_paged_limit'
       responses: