Merge pull request #89 from apivideo/bugfix/update-list-all-video-objects-descriptions

Update parameter descriptions and add enums

Author: bot-api-video

api/openapi.yaml

@@ -210,8 +210,7 @@ paths:
           type: object
         style: deepObject
         x-is-deep-object: true
-      - description: If you described a video with a term or sentence, you can add
-          it here to return videos containing this string.
+      - description: Retrieve video objects by `description`.
         example: New Zealand
         explode: true
         in: query
@@ -220,8 +219,8 @@ paths:
         schema:
           type: string
         style: form
-      - description: If you know the ID for a live stream, you can retrieve the stream
-          by adding the ID for it here.
+      - description: Retrieve video objects that were recorded from a live stream
+          by `liveStreamId`.
         example: li400mYKSgQ6xs7taUeSaEKr
         explode: true
         in: query
@@ -230,24 +229,32 @@ paths:
         schema:
           type: string
         style: form
-      - description: 'Allowed: publishedAt, title. You can search by the time videos
-          were published at, or by title.'
+      - description: Use this parameter to sort videos by the their created time,
+          published time, updated time, or by title.
         example: publishedAt
         explode: true
         in: query
         name: sortBy
         required: false
         schema:
+          enum:
+          - title
+          - createdAt
+          - publishedAt
+          - updatedAt
           type: string
         style: form
-      - description: 'Allowed: asc, desc. asc is ascending and sorts from A to Z.
-          desc is descending and sorts from Z to A.'
+      - description: Use this parameter to sort results. `asc` is ascending and sorts
+          from A to Z. `desc` is descending and sorts from Z to A.
         example: asc
         explode: true
         in: query
         name: sortOrder
         required: false
         schema:
+          enum:
+          - asc
+          - desc
           type: string
         style: form
       - description: 'Choose the number of search results to return per page. Minimum

docs/VideosApi.md

@@ -557,10 +557,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<String>**](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** | [**Map<String, String>**](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 `description`. | [optional]
+ **liveStreamId** | **String**| Retrieve video objects that were recorded from a live stream by `liveStreamId`. | [optional]
+ **sortBy** | **String**| Use this parameter to sort videos by the their created time, published time, updated time, or by title. | [optional] [enum: title, createdAt, publishedAt, updatedAt]
+ **sortOrder** | **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] [enum: asc, desc]
  **currentPage** | **Integer**| Choose the number of search results to return per page. Minimum value: 1 | [optional] [default to 1]
  **pageSize** | **Integer**| Results per page. Allowed values 1-100, default is 25. | [optional] [default to 25]
 

src/main/java/video/api/client/api/clients/VideosApi.java

@@ -2161,8 +2161,7 @@ public APIlistRequest metadata(Map<String, String> metadata) {
          * Set description
          * 
          * @param description
-         *            If you described a video with a term or sentence, you can add it here to return videos containing
-         *            this string. (optional)
+         *            Retrieve video objects by &#x60;description&#x60;. (optional)
          * 
          * @return APIlistRequest
          */
@@ -2175,7 +2174,7 @@ public APIlistRequest description(String description) {
          * Set liveStreamId
          * 
          * @param liveStreamId
-         *            If you know the ID for a live stream, you can retrieve the stream by adding the ID for it here.
+         *            Retrieve video objects that were recorded from a live stream by &#x60;liveStreamId&#x60;.
          *            (optional)
          * 
          * @return APIlistRequest
@@ -2189,8 +2188,8 @@ public APIlistRequest liveStreamId(String liveStreamId) {
          * Set sortBy
          * 
          * @param sortBy
-         *            Allowed: publishedAt, title. You can search by the time videos were published at, or by title.
-         *            (optional)
+         *            Use this parameter to sort videos by the their created time, published time, updated time, or by
+         *            title. (optional)
          * 
          * @return APIlistRequest
          */
@@ -2203,8 +2202,8 @@ public APIlistRequest sortBy(String sortBy) {
          * Set sortOrder
          * 
          * @param sortOrder
-         *            Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to
-         *            A. (optional)
+         *            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)
          * 
          * @return APIlistRequest
          */