-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTimeAddressableMediaStore.yaml
2233 lines (2211 loc) · 79.9 KB
/
TimeAddressableMediaStore.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright 2023 British Broadcasting Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
openapi: 3.1.0
info:
title: Time-addressable Media Store
description: |
The Time-addressable Media Store (TAMS) is used for storing segmented media flows.
The TAMS consists of a media store for the media flow segment objects and a service providing
a database index of the flow segments. This document is a specification of the service API.
See the [bbc/tams](https://github.com/bbc/tams) repository for more background on TAMS.
**Note**: the examples provided in this specification are for a system which uses a media
store that provides HTTP URLs for uploading and downloading media objects in buckets. This
could for example be implemented using an AWS S3 compatible store using presigned URLs or by
a simple file system storage with an HTTP frontend. Clients should parse the /service endpoint
and handle the media store type in use appropriately.
version: "5.1"
contact:
name: 'BBC R&D - Cloud-Fit Production Team'
email: '[email protected]'
url: https://github.com/bbc/tams
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: 'http://localhost:4010'
description: Local mock of API
- url: 'https://example.com/tams/{version}'
description: Example TAMS service
variables:
version:
description: API version
default: v5.1
security:
- {}
- basic_auth: []
- bearer_token_auth: []
paths:
/:
head:
summary: List Root Endpoints
description: Return root path headers
operationId: HEAD_root
tags:
- Service
responses:
"200":
$ref: '#/components/responses/trait_resource_listing_head_200'
get:
summary: List Root Endpoints
description: List of paths available from this API.
operationId: GET_root
tags:
- Service
responses:
"200":
description: ""
content:
application/json:
schema:
example:
- service
- flows
- sources
- flow-delete-requests
/service:
head:
summary: Service Information
description: Return service path headers
operationId: HEAD_service
tags:
- Service
responses:
"200":
$ref: '#/components/responses/trait_resource_listing_head_200'
get:
summary: Service Information
description: Provide information about the service, including the media store in use.
operationId: GET_service
tags:
- Service
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: schemas/service.json
example:
$ref: examples/service-get-200.json
post:
summary: Update Service Information
description: Update the service info.
operationId: POST_service
tags:
- Service
requestBody:
content:
application/json:
example:
$ref: examples/service-post.json
schema:
$ref: schemas/service-post.json
required: true
responses:
"200":
description: Success. The service info has been updated.
"400":
description: Bad request. Invalid service JSON.
/service/webhooks:
head:
summary: List Webhook URLs
description: Return webhooks path headers
operationId: HEAD_webhooks
tags:
- Webhooks
responses:
"200":
$ref: '#/components/responses/trait_resource_listing_head_200'
"404":
description: "Webhooks are not supported by this API implementation"
get:
summary: List Webhook URLs
description: |
Get the list of registered webhook URLs. Implementations SHOULD take steps to avoid displaying URLs to users
other than those who have suitable permissions (e.g. the owning user).
Availability of this endpoint is indicated by the name "webhooks" appearing in the `event_stream_mechanisms`
list on the service endpoint.
operationId: GET_webhooks
tags:
- Webhooks
responses:
"200":
description: Return the list of known webhook URLs. Note that the `api_key_value` will be omitted.
content:
application/json:
example:
- url: https://hook.example.com
api_key_name: Authorization
events:
- flows/created
- flows/updated
- flows/deleted
schema:
type: array
items:
$ref: "schemas/webhook.json"
"404":
description: "Webhooks are not supported by this API implementation"
post:
summary: Register Webhook URL
description: |
Register to receive event notifications as webhooks on a specified URL. Webhook messages will conform to the
format in the `webhooks` section of the API docs, depending on the event type (as defined in the same section).
Availability of this endpoint is indicated by the name "webhooks" appearing in the `event_stream_mechanisms`
list on the service endpoint.
Making a POST request to this endpoint with the same URL, API key name and value but a different list
of `events` SHOULD update the existing registration. POSTing an empty list of events SHOULD remove the
registration.
HTTP requests from the service SHOULD include a `api_key_name` header with the 'api_key_value' value. Clients SHOULD verify this against the value they provided when registering the webhook.
API implementations SHOULD consider the security implementations of providing webhooks, and include appropriate
mitigations against Server Side Request Forgery (SSRF) attacks and similar.
operationId: POST_webhooks
tags:
- Webhooks
requestBody:
content:
application/json:
example:
url: https://hook.example.com
api_key_name: Authorization
api_key_value: Bearer 21238dksdjqwpqscj9
events:
- flows/created
- flows/updated
schema:
$ref: schemas/webhook-post.json
required: true
responses:
"201":
description: Success. The webhook has been registered or updated
"204":
description: Success. The webhook has been removed
"400":
description: Bad request. Invalid parameters.
"404":
description: "Webhooks are not supported by this API implementation"
/sources:
head:
summary: List Sources
description: Return Sources path headers
operationId: HEAD_sources
tags:
- Sources
parameters:
- name: label
in: query
description: Filter on Sources that have the given label.
schema:
type: string
- name: tag.{name}
in: query
description: |
Filter on Sources that have a tag named {name} and with the given value.
The {name} could contain escaped characters to allow it to be used in a
URL.
schema:
type: string
- name: tag_exists.{name}
in: query
description: |
Filter on Sources that have a tag named {name} regardless of value. The
{name} could contain escaped characters to allow it to be used in a
URL. If set to true then the presence of the tag is filtered for. If set
to false then its absence is. If left out then no filtering on tag presence
is performed.
schema:
type: boolean
- $ref: '#/components/parameters/trait_resource_paged_key'
- $ref: '#/components/parameters/trait_paged_limit'
responses:
"200":
description: ""
headers:
Link:
description: Provides references to cursors for paging. Only the 'rel' attribute with value 'next' and a link to the next page is currently supported. If 'next' is not present then it is the last page.
schema:
type: string
X-Paging-Limit:
description: Identifies the current limit being used for paging. This may not match the requested value if the requested value was too high for the implementation
schema:
type: integer
X-Paging-NextKey:
description: Opaque string that can be supplied to the `page` query parameter to get the next page of results.
schema:
type: string
content:
application/json:
schema:
type: string
"400":
$ref: '#/components/responses/trait_resource_info_head_400'
get:
summary: List Sources
description: List the Sources registered in the store and their details.
operationId: GET_sources
tags:
- Sources
parameters:
- name: label
in: query
description: Filter on Sources that have the given label.
schema:
type: string
- name: tag.{name}
in: query
description: |
Filter on Sources that have a tag named {name} and with the given value.
The {name} could contain escaped characters to allow it to be used in a
URL.
schema:
type: string
- name: tag_exists.{name}
in: query
description: |
Filter on Sources that have a tag named {name} regardless of value. The
{name} could contain escaped characters to allow it to be used in a
URL. If set to true then the presence of the tag is filtered for. If set
to false then its absence is. If left out then no filtering on tag presence
is performed.
schema:
type: boolean
- name: format
in: query
description: Filter on source format.
schema:
$ref: '#/components/schemas/contentformat'
- $ref: '#/components/parameters/trait_resource_paged_key'
- $ref: '#/components/parameters/trait_paged_limit'
responses:
"200":
description: ""
headers:
Link:
description: Provides references to cursors for paging. Only the 'rel' attribute with value 'next' and a link to the next page is currently supported. If 'next' is not present then it is the last page.
schema:
type: string
X-Paging-Limit:
description: Identifies the current limit being used for paging. This may not match the requested value if the requested value was too high for the implementation
schema:
type: integer
X-Paging-NextKey:
description: Opaque string that can be supplied to the `page` query parameter to get the next page of results.
schema:
type: string
content:
application/json:
example:
$ref: examples/sources-get-200.json
schema:
type: array
items:
$ref: "schemas/source.json"
"400":
description: Bad request. Invalid query options.
/sources/{sourceId}:
parameters:
- name: sourceId
in: path
required: true
schema:
$ref: '#/components/schemas/uuid'
description: The Source identifier.
head:
summary: Source Details
description: Return Source headers
operationId: HEAD_sources-sourceId
tags:
- Sources
responses:
"200":
$ref: '#/components/responses/trait_resource_info_head_200'
"404":
$ref: '#/components/responses/trait_resource_info_head_404'
get:
summary: Source Details
description: Returns Source metadata.
operationId: GET_sources-sourceId
tags:
- Sources
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: schemas/source.json
examples:
basic:
summary: Source containing elemental video
value:
$ref: examples/source-get-200-basic.json
multi:
summary: Multi-essence Source
description: Multi-essence Sources collect multiple Sources of different formats under one Source ID.
value:
$ref: examples/source-get-200-multi.json
"404":
description: The requested Source does not exist.
/sources/{sourceId}/tags:
parameters:
- name: sourceId
in: path
required: true
schema:
$ref: '#/components/schemas/uuid'
description: The Source identifier.
head:
summary: List Source Tags
description: Return Source tags path headers
operationId: HEAD_sources-sourceId-tags
tags:
- Sources
responses:
"200":
$ref: '#/components/responses/trait_resource_listing_head_200'
"404":
description: The requested Source does not exist.
get:
summary: List Source Tags
description: Returns the Source tags.
operationId: GET_sources-sourceId-tags
tags:
- Sources
responses:
"200":
description: ""
content:
application/json:
example:
ingested_by: ingest_service_api
schema:
$ref: "schemas/tags.json"
"404":
description: The requested Source does not exist.
/sources/{sourceId}/tags/{name}:
parameters:
- name: name
in: path
required: true
schema:
type: string
description: The tag name.
- name: sourceId
in: path
required: true
schema:
$ref: '#/components/schemas/uuid'
description: The Source identifier.
head:
summary: Source Tag Value
description: Return Source tag path headers
operationId: HEAD_sources-sourceId-tags-name
tags:
- Sources
responses:
"200":
$ref: '#/components/responses/trait_resource_info_head_200'
"404":
description: The requested Source or tag does not exist.
get:
summary: Source Tag Value
description: Return the tag value associated with the tag name.
operationId: GET_sources-sourceId-tags-name
tags:
- Sources
responses:
"200":
description: ""
content:
application/json:
example: |
"ingest_service_api"
schema:
type: string
"404":
description: The requested Source or tag does not exist.
put:
summary: Create or Update Source Tag
description: Create or update the Source tag
operationId: PUT_sources-sourceId-tags-name
tags:
- Sources
requestBody:
content:
application/json:
example: |
"new_value"
schema:
type: string
required: true
responses:
"204":
description: No content. The tag has been created or updated.
"400":
description: Bad request. Invalid Source tag value.
"404":
description: The requested Source does not exist, or the tag name in the path is invalid.
delete:
summary: Delete Source Tag
description: Delete a specific tag on a Source
operationId: DELETE_sources-sourceId-tags-name
tags:
- Sources
responses:
"204":
description: No content. The Source tag has been deleted.
"404":
description: The requested Source ID or tag in the path is invalid.
/sources/{sourceId}/description:
parameters:
- name: sourceId
in: path
required: true
schema:
$ref: '#/components/schemas/uuid'
description: The Source identifier.
head:
summary: Source Description
description: Return Source description path headers
operationId: HEAD_sources-sourceId-description
tags:
- Sources
responses:
"200":
$ref: '#/components/responses/trait_resource_info_head_200'
"404":
$ref: '#/components/responses/trait_resource_info_head_404'
get:
summary: Source Description
description: Returns the Source description property.
operationId: GET_sources-sourceId-description
tags:
- Sources
responses:
"200":
description: ""
content:
application/json:
example: |
"Big Buck Bunny"
schema:
type: string
"404":
description: The requested Source does not exist.
put:
summary: Create or Update Source Description
description: Create or update the description property.
operationId: PUT_sources-sourceId-description
tags:
- Sources
requestBody:
content:
application/json:
example: |
"Big Buck Bunny Movie"
schema:
type: string
required: true
responses:
"204":
description: No content. The description has been created or updated.
"400":
description: Bad request. Invalid Source description.
"404":
description: The requested Source does not exist.
delete:
summary: Delete Source Description
description: Delete the description property.
operationId: DELETE_sources-sourceId-description
tags:
- Sources
responses:
"204":
description: No content. The Source description property has been deleted.
"404":
description: The Source ID in the path is invalid.
/sources/{sourceId}/label:
parameters:
- name: sourceId
in: path
required: true
schema:
$ref: '#/components/schemas/uuid'
description: The Source identifier.
head:
summary: Source Label
description: Return Source label path headers
operationId: HEAD_sources-sourceId-label
tags:
- Sources
responses:
"200":
$ref: '#/components/responses/trait_resource_info_head_200'
"404":
description: The requested Source does not exist, or does not have a label set.
get:
summary: Source Label
description: Returns the Source label property.
operationId: GET_sources-sourceId-label
tags:
- Sources
responses:
"200":
description: ""
content:
application/json:
example: |
"Big Buck Bunny"
schema:
type: string
"404":
description: The requested Source does not exist, or does not have a label set.
put:
summary: Create or Update Source Label
description: Create or update the label property.
operationId: PUT_sources-sourceId-label
tags:
- Sources
requestBody:
content:
application/json:
example: |
"Big Buck Bunny Movie"
schema:
type: string
required: true
responses:
"204":
description: No content. The label has been created or updated.
"400":
description: Bad request. Invalid Source label.
"404":
description: The requested Source does not exist.
delete:
summary: Delete Source Label
description: Delete the label property.
operationId: DELETE_sources-sourceId-label
tags:
- Sources
responses:
"204":
description: No content. The Source label property has been deleted.
"404":
description: The requested Source ID in the path is invalid.
/flows:
head:
summary: List Flows
description: Return flows path headers
operationId: HEAD_flows
tags:
- Flows
parameters:
- name: source_id
in: query
description: Filter on source identifier.
schema:
$ref: '#/components/schemas/uuid'
- name: timerange
in: query
description: Filter on flows that overlap the given timerange.
schema:
default: _
$ref: 'schemas/timerange.json'
- name: format
in: query
description: Filter on flow format.
schema:
$ref: '#/components/schemas/contentformat'
- name: codec
in: query
description: Filter on flow codec.
schema:
$ref: '#/components/schemas/mimetype'
- name: label
in: query
description: Filter on flows that have the given label.
schema:
type: string
- name: tag.{name}
in: query
description: |
Filter on flows that have a tag named {name} and with the given value.
The {name} could contain escaped characters to allow it to be used in a
URL.
schema:
type: string
- name: tag_exists.{name}
in: query
description: |
Filter on flows that have a tag named {name} regardless of value. The
{name} could contain escaped characters to allow it to be used in a
URL. If set to true then the presence of the tag is filtered for. If set
to false then its absence is. If left out then no filtering on tag presence
is performed.
schema:
type: boolean
- name: frame_width
in: query
description: Filter on video flows that have the given frame width.
schema:
type: integer
- name: frame_height
in: query
description: Filter on video flows that have the given frame height.
schema:
type: integer
- $ref: '#/components/parameters/trait_resource_paged_key'
- $ref: '#/components/parameters/trait_paged_limit'
responses:
"200":
description: ""
headers:
Link:
description: Provides references to cursors for paging. Only the 'rel' attribute with value 'next' and a link to the next page is currently supported. If 'next' is not present then it is the last page.
schema:
type: string
X-Paging-Limit:
description: Identifies the current limit being used for paging. This may not match the requested value if the requested value was too high for the implementation
schema:
type: integer
X-Paging-NextKey:
description: Opaque string that can be supplied to the `page` query parameter to get the next page of results.
schema:
type: string
content:
application/json:
schema:
type: string
"400":
description: Bad request. Invalid query options.
get:
summary: List Flows
description: List the flows registered in the store.
operationId: GET_flows
tags:
- Flows
parameters:
- name: source_id
in: query
description: Filter on source identifier.
schema:
$ref: '#/components/schemas/uuid'
- name: timerange
in: query
description: Filter on flows that overlap the given timerange. An empty timerange returns flows with no content.
schema:
default: _
$ref: 'schemas/timerange.json'
- name: format
in: query
description: Filter on flow format.
schema:
$ref: '#/components/schemas/contentformat'
- name: codec
in: query
description: Filter on flow codec.
schema:
$ref: '#/components/schemas/mimetype'
- name: label
in: query
description: Filter on flows that have the given label.
schema:
type: string
- name: tag.{name}
in: query
description: |
Filter on flows that have a tag named {name} and with the given value.
The {name} could contain escaped characters to allow it to be used in a
URL.
schema:
type: string
- name: tag_exists.{name}
in: query
description: |
Filter on flows that have a tag named {name} regardless of value. The
{name} could contain escaped characters to allow it to be used in a
URL. If set to true then the presence of the tag is filtered for. If set
to false then its absence is. If left out then no filtering on tag presence
is performed.
schema:
type: boolean
- name: frame_width
in: query
description: Filter on video flows that have the given frame width.
schema:
type: integer
- name: frame_height
in: query
description: Filter on video flows that have the given frame height.
schema:
type: integer
- $ref: '#/components/parameters/trait_resource_paged_key'
- $ref: '#/components/parameters/trait_paged_limit'
responses:
"200":
description: ""
headers:
Link:
description: Provides references to cursors for paging. Only the 'rel' attribute with value 'next' and a link to the next page is currently supported. If 'next' is not present then it is the last page.
schema:
type: string
X-Paging-Limit:
description: Identifies the current limit being used for paging. This may not match the requested value if the requested value was too high for the implementation
schema:
type: integer
X-Paging-NextKey:
description: Opaque string that can be supplied to the `page` query parameter to get the next page of results.
schema:
type: string
content:
application/json:
example:
$ref: examples/flows-get-200.json
schema:
type: array
items:
$ref: "schemas/flow.json"
"400":
description: Bad request. Invalid query options.
/flows/{flowId}:
parameters:
- name: flowId
in: path
required: true
schema:
$ref: '#/components/schemas/uuid'
description: The flow identifier.
head:
summary: Flow Details
description: Return flow path headers
operationId: HEAD_flows-flowId
tags:
- Flows
parameters:
- name: include_timerange
in: query
description: Include the available segment timerange in the response.
schema:
default: false
type: boolean
- name: timerange
in: query
description: Limit the returned available segment timerange to this timerange.
schema:
default: _
$ref: 'schemas/timerange.json'
responses:
"200":
$ref: '#/components/responses/trait_resource_info_head_200'
"400":
description: Bad request. Invalid query options.
"404":
$ref: '#/components/responses/trait_resource_info_head_404'
get:
summary: Flow Details
description: Returns flow metadata.
operationId: GET_flows-flowId
tags:
- Flows
parameters:
- name: include_timerange
in: query
description: Include the available segment timerange in the response.
schema:
default: false
type: boolean
- name: timerange
in: query
description: Limit the returned available segment timerange to this timerange.
schema:
default: _
$ref: 'schemas/timerange.json'
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: schemas/flow.json
examples:
video:
summary: Video Flow - H.264 Codec
value:
$ref: examples/flow-get-200-video-h264.json
audio:
summary: Audio Flow - AAC Codec
value:
$ref: examples/flow-get-200-audio-aac.json
rawvideo:
summary: Video Flow - Uncompressed (Quicktime)
value:
$ref: examples/flow-get-200-video-raw.json
ttml:
summary: Data Flow - TTML
description: TAMS can also be used for storing non-AV content such as subtitles or event data
value:
$ref: examples/flow-get-200-data-ttml.json
multi:
summary: Multi-essence Flow
description: Multi-essence Flows are used to collect multiple Flows of different formats under one Flow ID
value:
$ref: examples/flow-get-200-multi.json
multi-container-map:
summary: Multi-essence Flow with a container map
description: |
Multi-essence Flows are used to collect multiple Flows of different formats under one Flow ID.
The collection has container maps for the audio Flows as there are 2 audio tracks in the container.
value:
$ref: examples/flow-get-200-multi-container-map.json
audio-multi:
summary: Audio Flow in a multi-essence Flow
description: |
The audio Flow does not have a container property as the media is accessed via the multi-essence Flow
value:
$ref: examples/flow-get-200-audio-aac-multi.json
"404":
description: The requested flow does not exist.
"400":
description: Bad request. Invalid query options.
put:
summary: Create or Replace Flow
description: Create or replace the flow metadata.
operationId: PUT_flows-flowId
tags:
- Flows
requestBody:
content:
application/json:
examples:
audio:
summary: Stereo audio Flow
value:
$ref: examples/flow-put.json
multi:
summary: Multi-essence Flow
value:
$ref: examples/flow-put-multi.json
schema:
$ref: schemas/flow.json
required: true
responses:
"201":
description: The flow has been created.
content:
application/json:
example:
$ref: examples/flow-put-201.json
schema:
$ref: schemas/flow.json
"204":
description: No content. The flow has been updated.
"400":
description: Bad request. Invalid flow JSON.
"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.
delete:
summary: Delete Flow
description: |
Deletes the flow and associated segments. If flow segment deletion
takes too long then this request will return 202 Accepted and the `Location` header will point to a
Flow Delete Request to monitor deletion progress
operationId: DELETE_flows-flowId
tags:
- Flows
responses:
"202":
description: This request has taken longer than the configured timeout, and will continue asynchronously
headers:
Location:
schema:
type: string
example: /flow-delete-request/{request-id}
content:
application/json:
schema:
$ref: schemas/deletion-request.json
example:
$ref: examples/deletion-request-get-200.json
"204":
description: No content. The flow has been deleted and the flow segments have been or will be 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}/tags:
parameters:
- name: flowId
in: path
required: true
schema:
$ref: '#/components/schemas/uuid'
description: The flow identifier.
head:
summary: List Flow Tags
description: Return flow tags path headers
operationId: HEAD_flows-flowId-tags
tags:
- Flows
responses:
"200":
$ref: '#/components/responses/trait_resource_listing_head_200'
"404":
description: The requested flow does not exist.
get:
summary: List Flow Tags
description: Returns the flow tags.
operationId: GET_flows-flowId-tags
tags:
- Flows
responses:
"200":
description: ""
content:
application/json:
example:
$ref: examples/flow-tags-get-200.json
schema:
$ref: schemas/tags.json
"404":
description: The requested flow does not exist.
/flows/{flowId}/tags/{name}:
parameters:
- name: name
in: path
required: true
schema:
type: string
description: The tag name.
- name: flowId
in: path