Skip to content

Commit

Permalink
Update parameter descriptions and add enums
Browse files Browse the repository at this point in the history
  • Loading branch information
ThibaultBee committed Jul 5, 2023
1 parent ff7f58b commit 09fc779
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3eb2afd3380a2e1194d21245be70de774173595baf3a06fefd0c9c8d1c7f7f58
8661c973bd93b59ba5a00ce76d746ffb5d07e640ac5c33ae7eed6d66f9e6e669
16 changes: 8 additions & 8 deletions docs/VideosApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -475,10 +475,10 @@ namespace Example
var title = My Video.mp4; // string | The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. (optional)
var tags = new List<string>(); // List<string> | A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. (optional)
var metadata = new Dictionary<string, string>(); // Dictionary<string, string> | Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. (optional)
var description = New Zealand; // string | If you described a video with a term or sentence, you can add it here to return videos containing this string. (optional)
var liveStreamId = li400mYKSgQ6xs7taUeSaEKr; // string | If you know the ID for a live stream, you can retrieve the stream by adding the ID for it here. (optional)
var sortBy = publishedAt; // string | Allowed: publishedAt, title. You can search by the time videos were published at, or by title. (optional)
var sortOrder = asc; // string | Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. (optional)
var description = New Zealand; // string | Retrieve video objects by `description`. (optional)
var liveStreamId = li400mYKSgQ6xs7taUeSaEKr; // string | Retrieve video objects that were recorded from a live stream by `liveStreamId`. (optional)
var sortBy = publishedAt; // string | Use this parameter to sort videos by the their created time, published time, updated time, or by title. (optional)
var sortOrder = asc; // string | Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. (optional)
var currentPage = 2; // int? | Choose the number of search results to return per page. Minimum value: 1 (optional) (default to 1)
var pageSize = 30; // int? | Results per page. Allowed values 1-100, default is 25. (optional) (default to 25)
var apiVideosInstance = apiInstance.Videos();
Expand Down Expand Up @@ -506,10 +506,10 @@ Name | Type | Description | Notes
**title** | **string**| The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. | [optional]
**tags** | [**List&lt;string&gt;**](string.md)| A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. | [optional]
**metadata** | [**Dictionary&lt;string, string&gt;**](string.md)| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. | [optional]
**description** | **string**| If you described a video with a term or sentence, you can add it here to return videos containing this string. | [optional]
**liveStreamId** | **string**| If you know the ID for a live stream, you can retrieve the stream by adding the ID for it here. | [optional]
**sortBy** | **string**| Allowed: publishedAt, title. You can search by the time videos were published at, or by title. | [optional]
**sortOrder** | **string**| Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. | [optional]
**description** | **string**| Retrieve video objects by &#x60;description&#x60;. | [optional]
**liveStreamId** | **string**| Retrieve video objects that were recorded from a live stream by &#x60;liveStreamId&#x60;. | [optional]
**sortBy** | **string**| Use this parameter to sort videos by the their created time, published time, updated time, or by title. | [optional]
**sortOrder** | **string**| Use this parameter to sort results. &#x60;asc&#x60; is ascending and sorts from A to Z. &#x60;desc&#x60; is descending and sorts from Z to A. | [optional]
**currentPage** | **int?**| Choose the number of search results to return per page. Minimum value: 1 | [optional] [default to 1]
**pageSize** | **int?**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]

Expand Down
24 changes: 12 additions & 12 deletions src/Api/VideosApi.cs
Original file line number Diff line number Diff line change
Expand Up @@ -861,10 +861,10 @@ public ApiResponse<Object> deleteWithHttpInfo(string videoId)
/// <param name="title">The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. (optional)</param>
/// <param name="tags">A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. (optional)</param>
/// <param name="metadata">Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. (optional)</param>
/// <param name="description">If you described a video with a term or sentence, you can add it here to return videos containing this string. (optional)</param>
/// <param name="liveStreamId">If you know the ID for a live stream, you can retrieve the stream by adding the ID for it here. (optional)</param>
/// <param name="sortBy">Allowed: publishedAt, title. You can search by the time videos were published at, or by title. (optional)</param>
/// <param name="sortOrder">Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. (optional)</param>
/// <param name="description">Retrieve video objects by &#x60;description&#x60;. (optional)</param>
/// <param name="liveStreamId">Retrieve video objects that were recorded from a live stream by &#x60;liveStreamId&#x60;. (optional)</param>
/// <param name="sortBy">Use this parameter to sort videos by the their created time, published time, updated time, or by title. (optional)</param>
/// <param name="sortOrder">Use this parameter to sort results. &#x60;asc&#x60; is ascending and sorts from A to Z. &#x60;desc&#x60; is descending and sorts from Z to A. (optional)</param>
/// <param name="currentPage">Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)</param>
/// <param name="pageSize">Results per page. Allowed values 1-100, default is 25. (optional, default to 25)</param>

Expand All @@ -882,10 +882,10 @@ public VideosListResponse list(string title = default, List<string> tags = defau
/// <param name="title">The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. (optional)</param>
/// <param name="tags">A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. (optional)</param>
/// <param name="metadata">Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. (optional)</param>
/// <param name="description">If you described a video with a term or sentence, you can add it here to return videos containing this string. (optional)</param>
/// <param name="liveStreamId">If you know the ID for a live stream, you can retrieve the stream by adding the ID for it here. (optional)</param>
/// <param name="sortBy">Allowed: publishedAt, title. You can search by the time videos were published at, or by title. (optional)</param>
/// <param name="sortOrder">Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. (optional)</param>
/// <param name="description">Retrieve video objects by &#x60;description&#x60;. (optional)</param>
/// <param name="liveStreamId">Retrieve video objects that were recorded from a live stream by &#x60;liveStreamId&#x60;. (optional)</param>
/// <param name="sortBy">Use this parameter to sort videos by the their created time, published time, updated time, or by title. (optional)</param>
/// <param name="sortOrder">Use this parameter to sort results. &#x60;asc&#x60; is ascending and sorts from A to Z. &#x60;desc&#x60; is descending and sorts from Z to A. (optional)</param>
/// <param name="currentPage">Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)</param>
/// <param name="pageSize">Results per page. Allowed values 1-100, default is 25. (optional, default to 25)</param>

Expand Down Expand Up @@ -1015,7 +1015,7 @@ public class APIlistRequest {
/// <summary>
/// Set description
/// </summary>
/// <param name="description">If you described a video with a term or sentence, you can add it here to return videos containing this string. (optional)</param>
/// <param name="description">Retrieve video objects by &#x60;description&#x60;. (optional)</param>
/// <returns>APIlistRequest</returns>
public APIlistRequest Description(string description) {
this.description = description;
Expand All @@ -1025,7 +1025,7 @@ public class APIlistRequest {
/// <summary>
/// Set liveStreamId
/// </summary>
/// <param name="liveStreamId">If you know the ID for a live stream, you can retrieve the stream by adding the ID for it here. (optional)</param>
/// <param name="liveStreamId">Retrieve video objects that were recorded from a live stream by &#x60;liveStreamId&#x60;. (optional)</param>
/// <returns>APIlistRequest</returns>
public APIlistRequest LiveStreamId(string liveStreamId) {
this.liveStreamId = liveStreamId;
Expand All @@ -1035,7 +1035,7 @@ public class APIlistRequest {
/// <summary>
/// Set sortBy
/// </summary>
/// <param name="sortBy">Allowed: publishedAt, title. You can search by the time videos were published at, or by title. (optional)</param>
/// <param name="sortBy">Use this parameter to sort videos by the their created time, published time, updated time, or by title. (optional)</param>
/// <returns>APIlistRequest</returns>
public APIlistRequest SortBy(string sortBy) {
this.sortBy = sortBy;
Expand All @@ -1045,7 +1045,7 @@ public class APIlistRequest {
/// <summary>
/// Set sortOrder
/// </summary>
/// <param name="sortOrder">Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. (optional)</param>
/// <param name="sortOrder">Use this parameter to sort results. &#x60;asc&#x60; is ascending and sorts from A to Z. &#x60;desc&#x60; is descending and sorts from Z to A. (optional)</param>
/// <returns>APIlistRequest</returns>
public APIlistRequest SortOrder(string sortOrder) {
this.sortOrder = sortOrder;
Expand Down

0 comments on commit 09fc779

Please sign in to comment.