Merge pull request #89 from apivideo/fix-readmes-doctave-2

Fix brackets in READMEs for Doctave v2
apivideo · Jun 5, 2024 · 022ce5c · 022ce5c
2 parents 9e11fa1 + 66d4f04
commit 022ce5c
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 46 deletions.
diff --git a/docs/Api/AnalyticsApi.md b/docs/Api/AnalyticsApi.md
@@ -4,8 +4,8 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**getLiveStreamsPlays()**](AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** `/analytics/live-streams/plays`
-[**getVideosPlays()**](AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** `/analytics/videos/plays`
+[**getLiveStreamsPlays()**](AnalyticsApi.md#getLiveStreamsPlays) | Get play events for live stream | **GET** /analytics/live-streams/plays
+[**getVideosPlays()**](AnalyticsApi.md#getVideosPlays) | Get play events for video | **GET** /analytics/videos/plays
 
 
 ## **`getLiveStreamsPlays()` - Get play events for live stream**

diff --git a/docs/Api/CaptionsApi.md b/docs/Api/CaptionsApi.md
@@ -4,11 +4,11 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**upload()**](CaptionsApi.md#upload) | Upload a caption | **POST** `/videos/{videoId}/captions/{language}`
-[**get()**](CaptionsApi.md#get) | Retrieve a caption | **GET** `/videos/{videoId}/captions/{language}`
-[**update()**](CaptionsApi.md#update) | Update a caption | **PATCH** `/videos/{videoId}/captions/{language}`
-[**delete()**](CaptionsApi.md#delete) | Delete a caption | **DELETE** `/videos/{videoId}/captions/{language}`
-[**list()**](CaptionsApi.md#list) | List video captions | **GET** `/videos/{videoId}/captions`
+[**upload()**](CaptionsApi.md#upload) | Upload a caption | **POST** /videos/{videoId}/captions/{language}
+[**get()**](CaptionsApi.md#get) | Retrieve a caption | **GET** /videos/{videoId}/captions/{language}
+[**update()**](CaptionsApi.md#update) | Update a caption | **PATCH** /videos/{videoId}/captions/{language}
+[**delete()**](CaptionsApi.md#delete) | Delete a caption | **DELETE** /videos/{videoId}/captions/{language}
+[**list()**](CaptionsApi.md#list) | List video captions | **GET** /videos/{videoId}/captions
 
 
 ## **`upload()` - Upload a caption**

diff --git a/docs/Api/ChaptersApi.md b/docs/Api/ChaptersApi.md
@@ -4,10 +4,10 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**upload()**](ChaptersApi.md#upload) | Upload a chapter | **POST** `/videos/{videoId}/chapters/{language}`
-[**get()**](ChaptersApi.md#get) | Retrieve a chapter | **GET** `/videos/{videoId}/chapters/{language}`
-[**delete()**](ChaptersApi.md#delete) | Delete a chapter | **DELETE** `/videos/{videoId}/chapters/{language}`
-[**list()**](ChaptersApi.md#list) | List video chapters | **GET** `/videos/{videoId}/chapters`
+[**upload()**](ChaptersApi.md#upload) | Upload a chapter | **POST** /videos/{videoId}/chapters/{language}
+[**get()**](ChaptersApi.md#get) | Retrieve a chapter | **GET** /videos/{videoId}/chapters/{language}
+[**delete()**](ChaptersApi.md#delete) | Delete a chapter | **DELETE** /videos/{videoId}/chapters/{language}
+[**list()**](ChaptersApi.md#list) | List video chapters | **GET** /videos/{videoId}/chapters
 
 
 ## **`upload()` - Upload a chapter**

diff --git a/docs/Api/LiveStreamsApi.md b/docs/Api/LiveStreamsApi.md
@@ -4,13 +4,13 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**create()**](LiveStreamsApi.md#create) | Create live stream | **POST** `/live-streams`
-[**get()**](LiveStreamsApi.md#get) | Retrieve live stream | **GET** `/live-streams/{liveStreamId}`
-[**update()**](LiveStreamsApi.md#update) | Update a live stream | **PATCH** `/live-streams/{liveStreamId}`
-[**delete()**](LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** `/live-streams/{liveStreamId}`
-[**list()**](LiveStreamsApi.md#list) | List all live streams | **GET** `/live-streams`
-[**uploadThumbnail()**](LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/live-streams/{liveStreamId}/thumbnail`
-[**deleteThumbnail()**](LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** `/live-streams/{liveStreamId}/thumbnail`
+[**create()**](LiveStreamsApi.md#create) | Create live stream | **POST** /live-streams
+[**get()**](LiveStreamsApi.md#get) | Retrieve live stream | **GET** /live-streams/{liveStreamId}
+[**update()**](LiveStreamsApi.md#update) | Update a live stream | **PATCH** /live-streams/{liveStreamId}
+[**delete()**](LiveStreamsApi.md#delete) | Delete a live stream | **DELETE** /live-streams/{liveStreamId}
+[**list()**](LiveStreamsApi.md#list) | List all live streams | **GET** /live-streams
+[**uploadThumbnail()**](LiveStreamsApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /live-streams/{liveStreamId}/thumbnail
+[**deleteThumbnail()**](LiveStreamsApi.md#deleteThumbnail) | Delete a thumbnail | **DELETE** /live-streams/{liveStreamId}/thumbnail
 
 
 ## **`create()` - Create live stream**

diff --git a/docs/Api/PlayerThemesApi.md b/docs/Api/PlayerThemesApi.md
@@ -4,13 +4,13 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**create()**](PlayerThemesApi.md#create) | Create a player | **POST** `/players`
-[**get()**](PlayerThemesApi.md#get) | Retrieve a player | **GET** `/players/{playerId}`
-[**update()**](PlayerThemesApi.md#update) | Update a player | **PATCH** `/players/{playerId}`
-[**delete()**](PlayerThemesApi.md#delete) | Delete a player | **DELETE** `/players/{playerId}`
-[**list()**](PlayerThemesApi.md#list) | List all player themes | **GET** `/players`
-[**uploadLogo()**](PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** `/players/{playerId}/logo`
-[**deleteLogo()**](PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** `/players/{playerId}/logo`
+[**create()**](PlayerThemesApi.md#create) | Create a player | **POST** /players
+[**get()**](PlayerThemesApi.md#get) | Retrieve a player | **GET** /players/{playerId}
+[**update()**](PlayerThemesApi.md#update) | Update a player | **PATCH** /players/{playerId}
+[**delete()**](PlayerThemesApi.md#delete) | Delete a player | **DELETE** /players/{playerId}
+[**list()**](PlayerThemesApi.md#list) | List all player themes | **GET** /players
+[**uploadLogo()**](PlayerThemesApi.md#uploadLogo) | Upload a logo | **POST** /players/{playerId}/logo
+[**deleteLogo()**](PlayerThemesApi.md#deleteLogo) | Delete logo | **DELETE** /players/{playerId}/logo
 
 
 ## **`create()` - Create a player**

diff --git a/docs/Api/UploadTokensApi.md b/docs/Api/UploadTokensApi.md
@@ -4,10 +4,10 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**createToken()**](UploadTokensApi.md#createToken) | Generate an upload token | **POST** `/upload-tokens`
-[**getToken()**](UploadTokensApi.md#getToken) | Retrieve upload token | **GET** `/upload-tokens/{uploadToken}`
-[**deleteToken()**](UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** `/upload-tokens/{uploadToken}`
-[**list()**](UploadTokensApi.md#list) | List all active upload tokens | **GET** `/upload-tokens`
+[**createToken()**](UploadTokensApi.md#createToken) | Generate an upload token | **POST** /upload-tokens
+[**getToken()**](UploadTokensApi.md#getToken) | Retrieve upload token | **GET** /upload-tokens/{uploadToken}
+[**deleteToken()**](UploadTokensApi.md#deleteToken) | Delete an upload token | **DELETE** /upload-tokens/{uploadToken}
+[**list()**](UploadTokensApi.md#list) | List all active upload tokens | **GET** /upload-tokens
 
 
 ## **`createToken()` - Generate an upload token**

diff --git a/docs/Api/VideosApi.md b/docs/Api/VideosApi.md
@@ -4,16 +4,16 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**create()**](VideosApi.md#create) | Create a video object | **POST** `/videos`
-[**upload()**](VideosApi.md#upload) | Upload a video | **POST** `/videos/{videoId}/source`
-[**uploadWithUploadToken()**](VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** `/upload`
-[**get()**](VideosApi.md#get) | Retrieve a video object | **GET** `/videos/{videoId}`
-[**update()**](VideosApi.md#update) | Update a video object | **PATCH** `/videos/{videoId}`
-[**delete()**](VideosApi.md#delete) | Delete a video object | **DELETE** `/videos/{videoId}`
-[**list()**](VideosApi.md#list) | List all video objects | **GET** `/videos`
-[**uploadThumbnail()**](VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** `/videos/{videoId}/thumbnail`
-[**pickThumbnail()**](VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** `/videos/{videoId}/thumbnail`
-[**getStatus()**](VideosApi.md#getStatus) | Retrieve video status and details | **GET** `/videos/{videoId}/status`
+[**create()**](VideosApi.md#create) | Create a video object | **POST** /videos
+[**upload()**](VideosApi.md#upload) | Upload a video | **POST** /videos/{videoId}/source
+[**uploadWithUploadToken()**](VideosApi.md#uploadWithUploadToken) | Upload with an delegated upload token | **POST** /upload
+[**get()**](VideosApi.md#get) | Retrieve a video object | **GET** /videos/{videoId}
+[**update()**](VideosApi.md#update) | Update a video object | **PATCH** /videos/{videoId}
+[**delete()**](VideosApi.md#delete) | Delete a video object | **DELETE** /videos/{videoId}
+[**list()**](VideosApi.md#list) | List all video objects | **GET** /videos
+[**uploadThumbnail()**](VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST** /videos/{videoId}/thumbnail
+[**pickThumbnail()**](VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH** /videos/{videoId}/thumbnail
+[**getStatus()**](VideosApi.md#getStatus) | Retrieve video status and details | **GET** /videos/{videoId}/status
 
 
 ## **`create()` - Create a video object**

diff --git a/docs/Api/WatermarksApi.md b/docs/Api/WatermarksApi.md
@@ -4,9 +4,9 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**upload()**](WatermarksApi.md#upload) | Upload a watermark | **POST** `/watermarks`
-[**delete()**](WatermarksApi.md#delete) | Delete a watermark | **DELETE** `/watermarks/{watermarkId}`
-[**list()**](WatermarksApi.md#list) | List all watermarks | **GET** `/watermarks`
+[**upload()**](WatermarksApi.md#upload) | Upload a watermark | **POST** /watermarks
+[**delete()**](WatermarksApi.md#delete) | Delete a watermark | **DELETE** /watermarks/{watermarkId}
+[**list()**](WatermarksApi.md#list) | List all watermarks | **GET** /watermarks
 
 
 ## **`upload()` - Upload a watermark**

diff --git a/docs/Api/WebhooksApi.md b/docs/Api/WebhooksApi.md
@@ -4,10 +4,10 @@ All URIs are relative to https://ws.api.video.
 
 Method | Description | HTTP request
 ------------- | ------------- | -------------
-[**create()**](WebhooksApi.md#create) | Create Webhook | **POST** `/webhooks`
-[**get()**](WebhooksApi.md#get) | Retrieve Webhook details | **GET** `/webhooks/{webhookId}`
-[**delete()**](WebhooksApi.md#delete) | Delete a Webhook | **DELETE** `/webhooks/{webhookId}`
-[**list()**](WebhooksApi.md#list) | List all webhooks | **GET** `/webhooks`
+[**create()**](WebhooksApi.md#create) | Create Webhook | **POST** /webhooks
+[**get()**](WebhooksApi.md#get) | Retrieve Webhook details | **GET** /webhooks/{webhookId}
+[**delete()**](WebhooksApi.md#delete) | Delete a Webhook | **DELETE** /webhooks/{webhookId}
+[**list()**](WebhooksApi.md#list) | List all webhooks | **GET** /webhooks
 
 
 ## **`create()` - Create Webhook**