From 2002a27dc0815042a54444e3386e2b589e88e478 Mon Sep 17 00:00:00 2001 From: Olivier Lando Date: Mon, 22 Jul 2024 15:40:42 +0200 Subject: [PATCH] Add last changes in oas_apivideo from doc --- oas_apivideo.yaml | 120 +++++++++++++++++++++++----------------------- 1 file changed, 61 insertions(+), 59 deletions(-) diff --git a/oas_apivideo.yaml b/oas_apivideo.yaml index 3e2ffc01..a046079c 100644 --- a/oas_apivideo.yaml +++ b/oas_apivideo.yaml @@ -50,7 +50,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/authenticationinvalid_credentials' + type: 'https://docs.api.video/reference/authentication-invalid-user-credentials' title: The user credentials were incorrect. name: '' status: 400 @@ -126,7 +126,7 @@ paths: response: value: status: 400 - type: 'https://docs.api.video/docs/authenticationinvalid_credentials' + type: 'https://docs.api.video/reference/authentication-invalid-user-credentials' title: The user credentials were incorrect. name: '' x-client-action: refresh @@ -618,21 +618,21 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/attributerequired' + type: 'https://docs.api.video/reference/attribute-required' title: This attribute is required. name: title status: 400 problems: - - type: 'https://docs.api.video/docs/attributerequired' + - type: 'https://docs.api.video/reference/attribute-required' title: This attribute is required. name: title - - type: 'https://docs.api.video/docs/attributeinvalid' + - type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be a ISO8601 date. name: scheduledAt - - type: 'https://docs.api.video/docs/attributeinvalid' + - type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be an array. name: tags - - type: 'https://docs.api.video/docs/attributeinvalid' + - type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be an array. name: metadata '429': @@ -1010,21 +1010,21 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/filealreadyuploaded' + type: 'https://docs.api.video/reference/video-source-already-uploaded' title: The source of the video is already uploaded. name: file status: 400 problems: - - type: 'https://docs.api.video/docs/filealreadyuploaded' + - type: 'https://docs.api.video/reference/video-source-already-uploaded' title: The source of the video is already uploaded. name: file - - type: 'https://docs.api.video/docs/filealreadyuploaded' + - type: 'https://docs.api.video/reference/video-source-already-uploaded' title: The video xxxx has already been uploaded. name: video - - type: 'https://docs.api.video/docs/filemissing' + - type: 'https://docs.api.video/reference/uploaded-file-no-file' title: There is no uploaded file in the request. name: file - - type: 'https://docs.api.video/docs/multiplefilesuploaded' + - type: 'https://docs.api.video/reference/uploaded-file-multiple-files' title: There is more than one uploaded file in the request. name: file '404': @@ -1049,7 +1049,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: videoId status: 404 @@ -1352,7 +1352,7 @@ paths: response: value: status: 400 - type: 'https://docs.api.video/docs/fileextension' + type: 'https://docs.api.video/reference/uploaded-file-extension-invalid' title: 'Only [jpeg, jpg, JPG, JPEG, png, PNG] extensions are supported.' name: file '429': @@ -1812,7 +1812,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: watermarkId status: 404 @@ -1996,7 +1996,7 @@ paths: response: value: status: 400 - type: 'https://docs.api.video/docs/fileextension' + type: 'https://docs.api.video/reference/uploaded-file-extension-invalid' title: 'Only [jpeg, jpg, JPG, JPEG] extensions are supported.' name: file '404': @@ -2021,7 +2021,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: videoId status: 404 @@ -2322,7 +2322,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: videoId status: 404 @@ -2622,7 +2622,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: videoId status: 404 @@ -2866,7 +2866,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: videoId status: 404 @@ -3136,18 +3136,18 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/attributeinvalid' + type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be a ISO-8601 date. name: scheduledAt status: 400 problems: - - type: 'https://docs.api.video/docs/attributeinvalid' + - type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be a ISO-8601 date. name: scheduledAt - - type: 'https://docs.api.video/docs/attributeinvalid' + - type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be an array. name: tags - - type: 'https://docs.api.video/docs/attributeinvalid' + - type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be an array. name: metadata '404': @@ -3172,7 +3172,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: videoId status: 404 @@ -3515,7 +3515,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: videoId status: 404 @@ -5355,20 +5355,20 @@ paths: detail: This value should not be blank. name: restreams[0][name] Missing app name in serverUrl: - description: This error occurs when the rtmp app name is missing from `serverURL` in the `restreams` array. + description: This error occurs when the app name is missing from `serverURL` in the `restreams` array. value: type: https://docs.api.video/reference/invalid-attribute title: An attribute is invalid. status: 400 - detail: 'Missing app name: rtmp://[host]/[app name].' + detail: 'Missing app name: [rtmp|rtmps]://[host]/[app name].' name: restreams[0][serverUrl] Incorrect URL in serverUrl: - description: This error occurs when the URL you set in `serverURL` is not `rtmp`. + description: This error occurs when the URL you set in `serverURL` is not `rtmps` or `rtmp`. value: type: https://docs.api.video/reference/invalid-attribute title: An attribute is invalid. status: 400 - detail: 'RTMP URL should have the following format: rtmp://[host]/[app name].' + detail: 'RTMP URL should have the following format: [rtmp|rtmps]://[host]/[app name].' name: restreams[0][serverUrl] Too many restream destinations: description: This error occurs when you set more than 5 restream destinations. @@ -6125,20 +6125,20 @@ paths: detail: This value should not be blank. name: restreams[0][name] Missing app name in serverUrl: - description: This error occurs when the rtmp app name is missing from `serverURL` in the `restreams` array. + description: This error occurs when the app name is missing from `serverURL` in the `restreams` array. value: type: https://docs.api.video/reference/invalid-attribute title: An attribute is invalid. status: 400 - detail: 'Missing app name: rtmp://[host]/[app name].' + detail: 'Missing app name: [rtmp|rtmps]://[host]/[app name].' name: restreams[0][serverUrl] Incorrect URL in serverUrl: - description: This error occurs when the URL you set in `serverURL` is not `rtmp`. + description: This error occurs when the URL you set in `serverURL` is not `rtmps` or `rtmp`. value: type: https://docs.api.video/reference/invalid-attribute title: An attribute is invalid. status: 400 - detail: 'RTMP URL should have the following format: rtmp://[host]/[app name].' + detail: 'RTMP URL should have the following format: [rtmp|rtmps]://[host]/[app name].' name: restreams[0][serverUrl] Too many restream destinations: description: This error occurs when you set more than 5 restream destinations. @@ -6479,7 +6479,7 @@ paths: response: value: status: 400 - type: 'https://docs.api.video/docs/fileextension' + type: 'https://docs.api.video/reference/uploaded-file-extension-invalid' title: 'Only [jpeg, jpg, JPG, JPEG] extensions are supported.' name: file '404': @@ -6504,7 +6504,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: liveStreamId status: 404 @@ -6762,7 +6762,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: liveStreamId status: 404 @@ -10275,7 +10275,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: playerId status: 404 @@ -10512,7 +10512,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: playerId status: 404 @@ -10774,7 +10774,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: playerId status: 404 @@ -11097,7 +11097,7 @@ paths: response: value: status: 400 - type: 'https://docs.api.video/docs/fileextension' + type: 'https://docs.api.video/reference/uploaded-file-extension-invalid' title: 'Only [''jpg'', ''JPG'', ''jpeg'', ''JPEG'', ''png'', ''PNG''] extensions are supported.' name: file '404': @@ -11122,7 +11122,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: playerId status: 404 @@ -11385,7 +11385,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: playerId status: 404 @@ -11805,6 +11805,7 @@ paths: - `play` is the number of times your content has been played. - `play-rate` is the ratio that calculates the number of plays your content receives divided by its impressions. + - `play-total` is the total number of times a specific content has been played. You can only use the `media-id` breakdown with this metric. - `start` is the number of times playback was started. - `end` is the number of times playback has ended with the content watch until the end. - `impression` is the number of times your content has been loaded and was ready for playback. @@ -11816,6 +11817,7 @@ paths: enum: - play - play-rate + - play-total - start - end - impression @@ -12627,18 +12629,18 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/attributerequired' + type: 'https://docs.api.video/reference/attribute-required' events: This attribute is required. name: events status: 400 problems: - - type: 'https://docs.api.video/docs/attributerequired' + - type: 'https://docs.api.video/reference/attribute-required' title: This attribute is required. name: events - - type: 'https://docs.api.video/docs/attributerequired' + - type: 'https://docs.api.video/reference/attribute-required' title: This attribute is required. name: url - - type: 'https://docs.api.video/docs/attributeinvalid' + - type: 'https://docs.api.video/reference/invalid-attribute' title: This attribute must be an array. name: events '429': @@ -13120,7 +13122,7 @@ paths: examples: response: value: - type: 'https://docs.api.video/docs/resourcenot_found' + type: 'https://docs.api.video/reference/resource-not-found' title: The requested resource was not found. name: webhookId status: 404 @@ -13866,7 +13868,7 @@ components: example: dw-dew8-q6w9-k67w-1ws8 public: type: boolean - description: 'Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management).' + description: 'Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery/video-privacy-access-management).' example: true assets: $ref: '#/components/schemas/live-stream-assets' @@ -13879,7 +13881,7 @@ components: description: 'Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not.' example: true restreams: - description: Returns the list of RTMP restream destinations. + description: Returns the list of restream destinations. type: array items: $ref: '#/components/schemas/restreams-response-object' @@ -14156,7 +14158,7 @@ components: example: 'https://www.myvideo.url.com/video.mp4 OR vi4k0jvEUuaTdRAEjQ4JfOyl' public: type: boolean - description: 'Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/delivery-analytics/video-privacy-access-management)' + description: 'Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/delivery/video-privacy-access-management)' example: true default: true panoramic: @@ -14354,13 +14356,13 @@ components: example: My Live Stream Video public: type: boolean - description: 'Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management).' + description: 'Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery/video-privacy-access-management).' playerId: type: string description: The unique identifier for the player. example: pl4f4ferf5erfr5zed4fsdd restreams: - description: Use this parameter to add, edit, or remove RTMP services where you want to restream a live stream. The list can only contain up to 5 destinations. + description: Use this parameter to add, edit, or remove `RTMPS` or `RTMP` services where you want to restream a live stream. The list can only contain up to 5 destinations. maxItems: 5 type: array items: @@ -14385,13 +14387,13 @@ components: example: My Live Stream Video public: type: boolean - description: 'Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management).' + description: 'Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery/video-privacy-access-management).' playerId: type: string description: The unique ID for the player associated with a live stream that you want to update. example: pl45KFKdlddgk654dspkze restreams: - description: Use this parameter to add, edit, or remove RTMP services where you want to restream a live stream. The list can only contain up to 5 destinations. This operation updates all restream destinations in the same request. If you do not want to modify an existing restream destination, you need to include it in your request, otherwise it is removed. + description: Use this parameter to add, edit, or remove `RTMPS` or `RTMP` services where you want to restream a live stream. The list can only contain up to 5 destinations. This operation updates all restream destinations in the same request. If you do not want to modify an existing restream destination, you need to include it in your request, otherwise it is removed. maxItems: 5 type: array items: @@ -14408,9 +14410,9 @@ components: name: description: Use this parameter to define a name for the restream destination. type: string - example: My RTMP server + example: My restream server serverUrl: - description: Use this parameter to set the RTMP URL of the restream destination. + description: Use this parameter to set the `RTMPS` or `RTMP` server URL of the restream destination. type: string example: rtmp://my.broadcast.example.com/app streamKey: @@ -14424,9 +14426,9 @@ components: name: description: Returns the name of a restream destination. type: string - example: My RTMP server + example: My restream server serverUrl: - description: Returns the RTMP URL of a restream destination. + description: Returns the server URL of a restream destination. type: string example: rtmp://my.broadcast.example.com/app streamKey: