From 8e015c77403afde33dc1361b8774dc758bf3b4fd Mon Sep 17 00:00:00 2001 From: szekelyzol Date: Wed, 20 Dec 2023 11:17:02 +0000 Subject: [PATCH] Update get live streams sortby attribute --- api/openapi.yaml | 16 +++++++++++----- docs/LiveStreams.md | 4 ++-- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/api/openapi.yaml b/api/openapi.yaml index 00b0a79..3501758 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -3449,17 +3449,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. + `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/LiveStreams.md b/docs/LiveStreams.md index 1d01c0e..cf42cf8 100644 --- a/docs/LiveStreams.md +++ b/docs/LiveStreams.md @@ -297,7 +297,7 @@ func main() { req.StreamKey("dw-dew8-q6w9-k67w-1ws8") // string | The unique stream key that allows you to stream videos. req.Name("My Video") // string | You can filter live streams by their name or a part of their name. - req.SortBy("createdAt") // 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. + req.SortBy("createdAt") // 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. `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. req.SortOrder("desc") // 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. req.CurrentPage(int32(2)) // int32 | Choose the number of search results to return per page. Minimum value: 1 (default to 1) req.PageSize(int32(30)) // int32 | Results per page. Allowed values 1-100, default is 25. (default to 25) @@ -324,7 +324,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **streamKey** | **string** | The unique stream key that allows you to stream videos. | **name** | **string** | You can filter live streams by their name or a part of their name. | -**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. | +**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. `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. | **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. | **currentPage** | **int32** | Choose the number of search results to return per page. Minimum value: 1 | [default to 1] **pageSize** | **int32** | Results per page. Allowed values 1-100, default is 25. | [default to 25]