Skip to content

Commit e791054

Browse files
Merge pull request #28 from apivideo/improve-documentation
Add samples
2 parents 8f050c0 + 4954e93 commit e791054

18 files changed

+1649
-1649
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
144e85933c69e6a41e70a2bcc7d81b38188f62b87ca86d61022004f10eb45096
1+
abeebe9a0f30dc4d5ead8776da46cef6fac3169af18ab9e465d47484ad791fdb

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,11 @@ CaptionsAPI
102102

103103
Method | HTTP request | Description
104104
------------- | ------------- | -------------
105-
[**delete**](docs/CaptionsAPI.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption
106-
[**list**](docs/CaptionsAPI.md#list) | **GET** /videos/{videoId}/captions | List video captions
105+
[**upload**](docs/CaptionsAPI.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption
107106
[**get**](docs/CaptionsAPI.md#get) | **GET** /videos/{videoId}/captions/{language} | Retrieve a caption
108107
[**update**](docs/CaptionsAPI.md#update) | **PATCH** /videos/{videoId}/captions/{language} | Update a caption
109-
[**upload**](docs/CaptionsAPI.md#upload) | **POST** /videos/{videoId}/captions/{language} | Upload a caption
108+
[**delete**](docs/CaptionsAPI.md#delete) | **DELETE** /videos/{videoId}/captions/{language} | Delete a caption
109+
[**list**](docs/CaptionsAPI.md#list) | **GET** /videos/{videoId}/captions | List video captions
110110

111111

112112
### ChaptersAPI
@@ -121,10 +121,10 @@ ChaptersAPI
121121

122122
Method | HTTP request | Description
123123
------------- | ------------- | -------------
124+
[**upload**](docs/ChaptersAPI.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter
125+
[**get**](docs/ChaptersAPI.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter
124126
[**delete**](docs/ChaptersAPI.md#delete) | **DELETE** /videos/{videoId}/chapters/{language} | Delete a chapter
125127
[**list**](docs/ChaptersAPI.md#list) | **GET** /videos/{videoId}/chapters | List video chapters
126-
[**get**](docs/ChaptersAPI.md#get) | **GET** /videos/{videoId}/chapters/{language} | Retrieve a chapter
127-
[**upload**](docs/ChaptersAPI.md#upload) | **POST** /videos/{videoId}/chapters/{language} | Upload a chapter
128128

129129

130130
### LiveStreamsAPI
@@ -139,13 +139,13 @@ LiveStreamsAPI
139139

140140
Method | HTTP request | Description
141141
------------- | ------------- | -------------
142-
[**delete**](docs/LiveStreamsAPI.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream
143-
[**deleteThumbnail**](docs/LiveStreamsAPI.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail
144-
[**list**](docs/LiveStreamsAPI.md#list) | **GET** /live-streams | List all live streams
142+
[**create**](docs/LiveStreamsAPI.md#create) | **POST** /live-streams | Create live stream
145143
[**get**](docs/LiveStreamsAPI.md#get) | **GET** /live-streams/{liveStreamId} | Retrieve live stream
146144
[**update**](docs/LiveStreamsAPI.md#update) | **PATCH** /live-streams/{liveStreamId} | Update a live stream
147-
[**create**](docs/LiveStreamsAPI.md#create) | **POST** /live-streams | Create live stream
145+
[**delete**](docs/LiveStreamsAPI.md#delete) | **DELETE** /live-streams/{liveStreamId} | Delete a live stream
146+
[**list**](docs/LiveStreamsAPI.md#list) | **GET** /live-streams | List all live streams
148147
[**uploadThumbnail**](docs/LiveStreamsAPI.md#uploadThumbnail) | **POST** /live-streams/{liveStreamId}/thumbnail | Upload a thumbnail
148+
[**deleteThumbnail**](docs/LiveStreamsAPI.md#deleteThumbnail) | **DELETE** /live-streams/{liveStreamId}/thumbnail | Delete a thumbnail
149149

150150

151151
### PlayerThemesAPI
@@ -160,13 +160,13 @@ PlayerThemesAPI
160160

161161
Method | HTTP request | Description
162162
------------- | ------------- | -------------
163-
[**delete**](docs/PlayerThemesAPI.md#delete) | **DELETE** /players/{playerId} | Delete a player
164-
[**deleteLogo**](docs/PlayerThemesAPI.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo
165-
[**list**](docs/PlayerThemesAPI.md#list) | **GET** /players | List all player themes
163+
[**create**](docs/PlayerThemesAPI.md#create) | **POST** /players | Create a player
166164
[**get**](docs/PlayerThemesAPI.md#get) | **GET** /players/{playerId} | Retrieve a player
167165
[**update**](docs/PlayerThemesAPI.md#update) | **PATCH** /players/{playerId} | Update a player
168-
[**create**](docs/PlayerThemesAPI.md#create) | **POST** /players | Create a player
166+
[**delete**](docs/PlayerThemesAPI.md#delete) | **DELETE** /players/{playerId} | Delete a player
167+
[**list**](docs/PlayerThemesAPI.md#list) | **GET** /players | List all player themes
169168
[**uploadLogo**](docs/PlayerThemesAPI.md#uploadLogo) | **POST** /players/{playerId}/logo | Upload a logo
169+
[**deleteLogo**](docs/PlayerThemesAPI.md#deleteLogo) | **DELETE** /players/{playerId}/logo | Delete logo
170170

171171

172172
### RawStatisticsAPI
@@ -198,10 +198,10 @@ UploadTokensAPI
198198

199199
Method | HTTP request | Description
200200
------------- | ------------- | -------------
201+
[**createToken**](docs/UploadTokensAPI.md#createToken) | **POST** /upload-tokens | Generate an upload token
202+
[**getToken**](docs/UploadTokensAPI.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token
201203
[**deleteToken**](docs/UploadTokensAPI.md#deleteToken) | **DELETE** /upload-tokens/{uploadToken} | Delete an upload token
202204
[**list**](docs/UploadTokensAPI.md#list) | **GET** /upload-tokens | List all active upload tokens.
203-
[**getToken**](docs/UploadTokensAPI.md#getToken) | **GET** /upload-tokens/{uploadToken} | Retrieve upload token
204-
[**createToken**](docs/UploadTokensAPI.md#createToken) | **POST** /upload-tokens | Generate an upload token
205205

206206

207207
### VideosAPI
@@ -216,16 +216,16 @@ VideosAPI
216216

217217
Method | HTTP request | Description
218218
------------- | ------------- | -------------
219-
[**delete**](docs/VideosAPI.md#delete) | **DELETE** /videos/{videoId} | Delete a video
220-
[**get**](docs/VideosAPI.md#get) | **GET** /videos/{videoId} | Retrieve a video
221-
[**getStatus**](docs/VideosAPI.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status
222-
[**list**](docs/VideosAPI.md#list) | **GET** /videos | List all videos
223-
[**update**](docs/VideosAPI.md#update) | **PATCH** /videos/{videoId} | Update a video
224-
[**pickThumbnail**](docs/VideosAPI.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Pick a thumbnail
225-
[**uploadWithUploadToken**](docs/VideosAPI.md#uploadWithUploadToken) | **POST** /upload | Upload with an upload token
226219
[**create**](docs/VideosAPI.md#create) | **POST** /videos | Create a video
227220
[**upload**](docs/VideosAPI.md#upload) | **POST** /videos/{videoId}/source | Upload a video
221+
[**uploadWithUploadToken**](docs/VideosAPI.md#uploadWithUploadToken) | **POST** /upload | Upload with an upload token
222+
[**get**](docs/VideosAPI.md#get) | **GET** /videos/{videoId} | Retrieve a video
223+
[**update**](docs/VideosAPI.md#update) | **PATCH** /videos/{videoId} | Update a video
224+
[**delete**](docs/VideosAPI.md#delete) | **DELETE** /videos/{videoId} | Delete a video
225+
[**list**](docs/VideosAPI.md#list) | **GET** /videos | List all videos
228226
[**uploadThumbnail**](docs/VideosAPI.md#uploadThumbnail) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail
227+
[**pickThumbnail**](docs/VideosAPI.md#pickThumbnail) | **PATCH** /videos/{videoId}/thumbnail | Pick a thumbnail
228+
[**getStatus**](docs/VideosAPI.md#getStatus) | **GET** /videos/{videoId}/status | Retrieve video status
229229

230230

231231
### WatermarksAPI
@@ -240,9 +240,9 @@ WatermarksAPI
240240

241241
Method | HTTP request | Description
242242
------------- | ------------- | -------------
243+
[**upload**](docs/WatermarksAPI.md#upload) | **POST** /watermarks | Upload a watermark
243244
[**delete**](docs/WatermarksAPI.md#delete) | **DELETE** /watermarks/{watermarkId} | Delete a watermark
244245
[**list**](docs/WatermarksAPI.md#list) | **GET** /watermarks | List all watermarks
245-
[**upload**](docs/WatermarksAPI.md#upload) | **POST** /watermarks | Upload a watermark
246246

247247

248248
### WebhooksAPI
@@ -257,10 +257,10 @@ WebhooksAPI
257257

258258
Method | HTTP request | Description
259259
------------- | ------------- | -------------
260-
[**delete**](docs/WebhooksAPI.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook
260+
[**create**](docs/WebhooksAPI.md#create) | **POST** /webhooks | Create Webhook
261261
[**get**](docs/WebhooksAPI.md#get) | **GET** /webhooks/{webhookId} | Retrieve Webhook details
262+
[**delete**](docs/WebhooksAPI.md#delete) | **DELETE** /webhooks/{webhookId} | Delete a Webhook
262263
[**list**](docs/WebhooksAPI.md#list) | **GET** /webhooks | List all webhooks
263-
[**create**](docs/WebhooksAPI.md#create) | **POST** /webhooks | Create Webhook
264264

265265

266266

0 commit comments

Comments
 (0)