diff --git a/api/openapi.yaml b/api/openapi.yaml index 71ecab9..9168c41 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -3478,17 +3478,23 @@ paths: schema: type: string style: form - - description: 'Allowed: createdAt, publishedAt, name. createdAt - the time - a livestream was created using the specified streamKey. publishedAt - the - time a livestream was published using the specified streamKey. name - the - name of the livestream. If you choose one of the time based options, the - time is presented in ISO-8601 format.' + - description: | + Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. + `name` - the name of the live stream. + `createdAt` - the time a live stream was created using. + `updatedAt` - the time a live stream was last updated. + + When using `createdAt` or `updatedAt`, the API sorts the results based on the ISO-8601 time format. example: createdAt explode: true in: query name: sortBy required: false schema: + enum: + - name + - createdAt + - updatedAt type: string style: form - description: 'Allowed: asc, desc. Ascending for date and time means that earlier diff --git a/docs/LiveStreamsApi.md b/docs/LiveStreamsApi.md index 091b982..37c6c77 100644 --- a/docs/LiveStreamsApi.md +++ b/docs/LiveStreamsApi.md @@ -317,7 +317,7 @@ public class Example { String streamKey = "dw-dew8-q6w9-k67w-1ws8"; // The unique stream key that allows you to stream videos. String name = "My Video"; // You can filter live streams by their name or a part of their name. - String sortBy = "createdAt"; // Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format. + String sortBy = "name"; // Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. `name` - the name of the live stream. `createdAt` - the time a live stream was created using. `updatedAt` - the time a live stream was last updated. When using `createdAt` or `updatedAt`, the API sorts the results based on the ISO-8601 time format. String sortOrder = "asc"; // Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. Integer currentPage = 1; // Choose the number of search results to return per page. Minimum value: 1 Integer pageSize = 25; // Results per page. Allowed values 1-100, default is 25. @@ -349,7 +349,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **streamKey** | **String**| The unique stream key that allows you to stream videos. | [optional] **name** | **String**| You can filter live streams by their name or a part of their name. | [optional] - **sortBy** | **String**| Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format. | [optional] + **sortBy** | **String**| Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. `name` - the name of the live stream. `createdAt` - the time a live stream was created using. `updatedAt` - the time a live stream was last updated. When using `createdAt` or `updatedAt`, the API sorts the results based on the ISO-8601 time format. | [optional] [enum: name, createdAt, updatedAt] **sortOrder** | **String**| Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. | [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] diff --git a/src/main/java/video/api/client/api/clients/LiveStreamsApi.java b/src/main/java/video/api/client/api/clients/LiveStreamsApi.java index 799e7c7..2653eb4 100644 --- a/src/main/java/video/api/client/api/clients/LiveStreamsApi.java +++ b/src/main/java/video/api/client/api/clients/LiveStreamsApi.java @@ -960,10 +960,11 @@ public APIlistRequest name(String name) { * Set sortBy * * @param sortBy - * Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the - * specified streamKey. publishedAt - the time a livestream was published using the specified - * streamKey. name - the name of the livestream. If you choose one of the time based options, the - * time is presented in ISO-8601 format. (optional) + * Enables you to sort live stream results. Allowed attributes: `name`, + * `createdAt`, `updatedAt`. `name` - the name of the live stream. + * `createdAt` - the time a live stream was created using. `updatedAt` - the time + * a live stream was last updated. When using `createdAt` or `updatedAt`, the API + * sorts the results based on the ISO-8601 time format. (optional) * * @return APIlistRequest */