Skip to content

Commit

Permalink
[DO NOT MERGE] Add Watch Data endpoints to OpenAPI spec
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierapivideo authored Jun 5, 2024
1 parent 83d6f8a commit 10f05e4
Show file tree
Hide file tree
Showing 40 changed files with 257 additions and 2,714 deletions.
106 changes: 47 additions & 59 deletions README.md

Large diffs are not rendered by default.

386 changes: 69 additions & 317 deletions api/openapi.yaml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/AdvancedAuthenticationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ All URIs are relative to *https://ws.api.video*

Method | HTTP request | Description
------------- | ------------- | -------------
[**authenticate**](AdvancedAuthenticationApi.md#authenticate) | **POST** /auth/api-key | Get Bearer Token
[**refresh**](AdvancedAuthenticationApi.md#refresh) | **POST** /auth/refresh | Refresh Bearer Token
[**authenticate**](AdvancedAuthenticationApi.md#authenticate) | **POST** aa /auth/api-key | Get Bearer Token
[**refresh**](AdvancedAuthenticationApi.md#refresh) | **POST** aa /auth/refresh | Refresh Bearer Token


<a name="authenticate"></a>
Expand Down
8 changes: 4 additions & 4 deletions docs/AnalyticsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ All URIs are relative to *https://ws.api.video*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getLiveStreamsPlays**](AnalyticsApi.md#getLiveStreamsPlays) | **GET** /analytics/live-streams/plays | Get play events for live stream
[**getVideosPlays**](AnalyticsApi.md#getVideosPlays) | **GET** /analytics/videos/plays | Get play events for video
[**getLiveStreamsPlays**](AnalyticsApi.md#getLiveStreamsPlays) | **GET** aa /analytics/live-streams/plays | Get play events for live stream
[**getVideosPlays**](AnalyticsApi.md#getVideosPlays) | **GET** aa /analytics/videos/plays | Get play events for video


<a name="getLiveStreamsPlays"></a>
Expand All @@ -16,7 +16,7 @@ Method | HTTP request | Description
Get play events for live stream

Retrieve filtered analytics about the number of plays for your live streams in a project.
Retrieve filtered analytics about the number of plays for your live streams in a project. This endpoint will be deprecated with the release of Analytics v2.0.

### Example
```java
Expand Down Expand Up @@ -103,7 +103,7 @@ Name | Type | Description | Notes
Get play events for video

Retrieve filtered analytics about the number of plays for your videos in a project.
Retrieve filtered analytics about the number of plays for your videos in a project. This endpoint will be deprecated with the release of Analytics v2.0.

### Example
```java
Expand Down
10 changes: 5 additions & 5 deletions docs/CaptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ All URIs are relative to *https://ws.api.video*

Method | HTTP request | Description
------------- | ------------- | -------------
[**upload**](CaptionsApi.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption
[**get**](CaptionsApi.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption
[**update**](CaptionsApi.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption
[**delete**](CaptionsApi.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption
[**list**](CaptionsApi.md#list) | **GET** /videos/{videoId}/captions | List video captions
[**upload**](CaptionsApi.md#upload) | **POST** aa /videos/{videoId}/captions/{language} | Upload a caption
[**get**](CaptionsApi.md#get) | **GET** aa /videos/{videoId}/captions/{language} | Retrieve a caption
[**update**](CaptionsApi.md#update) | **PATCH** aa /videos/{videoId}/captions/{language} | Update a caption
[**delete**](CaptionsApi.md#delete) | **DELETE** aa /videos/{videoId}/captions/{language} | Delete a caption
[**list**](CaptionsApi.md#list) | **GET** aa /videos/{videoId}/captions | List video captions


<a name="upload"></a>
Expand Down
8 changes: 4 additions & 4 deletions docs/ChaptersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ All URIs are relative to *https://ws.api.video*

Method | HTTP request | Description
------------- | ------------- | -------------
[**upload**](ChaptersApi.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter
[**get**](ChaptersApi.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter
[**delete**](ChaptersApi.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter
[**list**](ChaptersApi.md#list) | **GET** /videos/{videoId}/chapters | List video chapters
[**upload**](ChaptersApi.md#upload) | **POST** aa /videos/{videoId}/chapters/{language} | Upload a chapter
[**get**](ChaptersApi.md#get) | **GET** aa /videos/{videoId}/chapters/{language} | Retrieve a chapter
[**delete**](ChaptersApi.md#delete) | **DELETE** aa /videos/{videoId}/chapters/{language} | Delete a chapter
[**list**](ChaptersApi.md#list) | **GET** aa /videos/{videoId}/chapters | List video chapters


<a name="upload"></a>
Expand Down
21 changes: 0 additions & 21 deletions docs/LiveStreamSession.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/LiveStreamSessionClient.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/LiveStreamSessionDevice.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/LiveStreamSessionLocation.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/LiveStreamSessionReferrer.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/LiveStreamSessionSession.md

This file was deleted.

14 changes: 7 additions & 7 deletions docs/LiveStreamsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ All URIs are relative to *https://ws.api.video*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](LiveStreamsApi.md#create) | **POST** /live-streams | Create live stream
[**get**](LiveStreamsApi.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream
[**update**](LiveStreamsApi.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream
[**delete**](LiveStreamsApi.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream
[**list**](LiveStreamsApi.md#list) | **GET** /live-streams | List all live streams
[**uploadThumbnail**](LiveStreamsApi.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail
[**deleteThumbnail**](LiveStreamsApi.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail
[**create**](LiveStreamsApi.md#create) | **POST** aa /live-streams | Create live stream
[**get**](LiveStreamsApi.md#get) | **GET** aa /live-streams/{liveStreamId} | Retrieve live stream
[**update**](LiveStreamsApi.md#update) | **PATCH** aa /live-streams/{liveStreamId} | Update a live stream
[**delete**](LiveStreamsApi.md#delete) | **DELETE** aa /live-streams/{liveStreamId} | Delete a live stream
[**list**](LiveStreamsApi.md#list) | **GET** aa /live-streams | List all live streams
[**uploadThumbnail**](LiveStreamsApi.md#uploadThumbnail) | **POST** aa /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail
[**deleteThumbnail**](LiveStreamsApi.md#deleteThumbnail) | **DELETE** aa /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail


<a name="create"></a>
Expand Down
14 changes: 7 additions & 7 deletions docs/PlayerThemesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ All URIs are relative to *https://ws.api.video*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](PlayerThemesApi.md#create) | **POST** /players | Create a player
[**get**](PlayerThemesApi.md#get) | **GET** /players/{playerId} | Retrieve a player
[**update**](PlayerThemesApi.md#update) | **PATCH** /players/{playerId} | Update a player
[**delete**](PlayerThemesApi.md#delete) | **DELETE** /players/{playerId} | Delete a player
[**list**](PlayerThemesApi.md#list) | **GET** /players | List all player themes
[**uploadLogo**](PlayerThemesApi.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo
[**deleteLogo**](PlayerThemesApi.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo
[**create**](PlayerThemesApi.md#create) | **POST** aa /players | Create a player
[**get**](PlayerThemesApi.md#get) | **GET** aa /players/{playerId} | Retrieve a player
[**update**](PlayerThemesApi.md#update) | **PATCH** aa /players/{playerId} | Update a player
[**delete**](PlayerThemesApi.md#delete) | **DELETE** aa /players/{playerId} | Delete a player
[**list**](PlayerThemesApi.md#list) | **GET** aa /players | List all player themes
[**uploadLogo**](PlayerThemesApi.md#uploadLogo) | **POST** aa /players/{playerId}/logo | Upload a logo
[**deleteLogo**](PlayerThemesApi.md#deleteLogo) | **DELETE** aa /players/{playerId}/logo | Delete logo


<a name="create"></a>
Expand Down
18 changes: 18 additions & 0 deletions docs/UnrecognizedRequestUrl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@


# UnrecognizedRequestUrl

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | A link to the error documentation. | [optional]
**title** | **String** | A description of the error that occurred. | [optional]
**status** | **Integer** | The HTTP status code. | [optional]


## Implemented Interfaces

* Serializable


8 changes: 4 additions & 4 deletions docs/UploadTokensApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ All URIs are relative to *https://ws.api.video*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createToken**](UploadTokensApi.md#createToken) | **POST** /upload-tokens | Generate an upload token
[**getToken**](UploadTokensApi.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token
[**deleteToken**](UploadTokensApi.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token
[**list**](UploadTokensApi.md#list) | **GET** /upload-tokens | List all active upload tokens
[**createToken**](UploadTokensApi.md#createToken) | **POST** aa /upload-tokens | Generate an upload token
[**getToken**](UploadTokensApi.md#getToken) | **GET** aa /upload-tokens/{uploadToken} | Retrieve upload token
[**deleteToken**](UploadTokensApi.md#deleteToken) | **DELETE** aa /upload-tokens/{uploadToken} | Delete an upload token
[**list**](UploadTokensApi.md#list) | **GET** aa /upload-tokens | List all active upload tokens


<a name="createToken"></a>
Expand Down
21 changes: 0 additions & 21 deletions docs/VideoSession.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/VideoSessionClient.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/VideoSessionDevice.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/VideoSessionLocation.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/VideoSessionOs.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/VideoSessionReferrer.md

This file was deleted.

Loading

0 comments on commit 10f05e4

Please sign in to comment.