From b13285e2eefab5a5c49e19013b9b9b5a593f7ee2 Mon Sep 17 00:00:00 2001 From: GH Action CI Stream Date: Wed, 2 Aug 2023 08:53:12 +0000 Subject: [PATCH] Update video openapi Spec --- openapi/video-openapi-clientside.yaml | 395 ++++++++++++++++++++------ openapi/video-openapi.yaml | 395 ++++++++++++++++++++------ 2 files changed, 612 insertions(+), 178 deletions(-) diff --git a/openapi/video-openapi-clientside.yaml b/openapi/video-openapi-clientside.yaml index 1c5221d6..3cad1342 100644 --- a/openapi/video-openapi-clientside.yaml +++ b/openapi/video-openapi-clientside.yaml @@ -1747,23 +1747,23 @@ components: data: $ref: '#/components/schemas/CallRequest' title: Data - x-stream-index: "004" + x-stream-index: "003" members_limit: format: int32 maximum: 100 type: integer - x-stream-index: "007" + x-stream-index: "006" notify: description: if provided it sends a notification event to the members for this call title: Notify type: boolean - x-stream-index: "006" + x-stream-index: "005" ring: description: if provided it sends a ring event to the members for this call title: Ring type: boolean - x-stream-index: "005" + x-stream-index: "004" type: object GetOrCreateCallResponse: nullable: true @@ -1905,35 +1905,35 @@ components: description: if true the call will be created if it doesn't exist title: Create type: boolean - x-stream-index: "003" + x-stream-index: "002" data: $ref: '#/components/schemas/CallRequest' - x-stream-index: "004" + x-stream-index: "003" location: title: Location type: string - x-stream-index: "009" + x-stream-index: "008" members_limit: format: int32 maximum: 100 title: The amount of members that should be returned type: integer - x-stream-index: "007" + x-stream-index: "006" migrating_from: description: If the participant is migrating from another SFU, then this is the ID of the previous SFU title: MigratingFrom type: string - x-stream-index: "010" + x-stream-index: "009" notify: type: boolean - x-stream-index: "006" + x-stream-index: "005" ring: description: if true and the call is created, the notification will include ring=true title: Ring type: boolean - x-stream-index: "005" + x-stream-index: "004" required: - location type: object @@ -2082,24 +2082,24 @@ components: audio: title: Audio type: boolean - x-stream-index: "006" + x-stream-index: "005" mute_all_users: type: boolean - x-stream-index: "004" + x-stream-index: "003" screenshare: title: Screenshare type: boolean - x-stream-index: "008" + x-stream-index: "007" user_ids: items: type: string title: UserIDs type: array - x-stream-index: "005" + x-stream-index: "004" video: title: Video type: boolean - x-stream-index: "007" + x-stream-index: "006" type: object MuteUsersResponse: nullable: true @@ -2123,6 +2123,7 @@ components: - join-call - join-ended-call - mute-users + - pin-for-everyone - read-call - remove-call-member - screenshare @@ -2232,6 +2233,30 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + PinRequest: + nullable: true + properties: + session_id: + type: string + x-stream-index: "003" + user_id: + type: string + x-stream-index: "002" + required: + - user_id + - session_id + type: object + PinResponse: + nullable: true + properties: + duration: + description: Duration of the request in human-readable format + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object QueryCallsRequest: nullable: true properties: @@ -2289,33 +2314,33 @@ components: filter_conditions: additionalProperties: {} type: object - x-stream-index: "003" + x-stream-index: "002" id: maxLength: 64 type: string - x-stream-index: "002" + x-stream-index: "001.002" limit: format: int32 maximum: 25 minimum: 0 type: integer - x-stream-index: "005.001" + x-stream-index: "004.001" next: type: string - x-stream-index: "005.002" + x-stream-index: "004.002" prev: type: string - x-stream-index: "005.003" + x-stream-index: "004.003" sort: items: $ref: '#/components/schemas/SortParamRequest' maximum: 1 type: array - x-stream-index: "004" + x-stream-index: "003" type: maxLength: 64 type: string - x-stream-index: "001" + x-stream-index: "001.001" required: - type - id @@ -2442,7 +2467,7 @@ components: type: string title: Permissions type: array - x-stream-index: "004" + x-stream-index: "003" required: - permissions type: object @@ -2550,14 +2575,14 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "004.003" + x-stream-index: "003.003" emoji_code: type: string - x-stream-index: "004.002" + x-stream-index: "003.002" type: maxLength: 64 type: string - x-stream-index: "004.001" + x-stream-index: "003.001" required: - type type: object @@ -2821,6 +2846,30 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UnpinRequest: + nullable: true + properties: + session_id: + type: string + x-stream-index: "003" + user_id: + type: string + x-stream-index: "002" + required: + - user_id + - session_id + type: object + UnpinResponse: + nullable: true + properties: + duration: + description: Duration of the request in human-readable format + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object UpdateCallMembersRequest: nullable: true properties: @@ -2831,7 +2880,7 @@ components: maximum: 100 title: Remove Members type: array - x-stream-index: "004" + x-stream-index: "003" update_members: description: List of members to update or insert items: @@ -2839,7 +2888,7 @@ components: maximum: 100 title: Update Members type: array - x-stream-index: "005" + x-stream-index: "004" type: object UpdateCallMembersResponse: nullable: true @@ -2866,18 +2915,18 @@ components: description: Custom data for this object title: Custom data type: object - x-stream-index: "004" + x-stream-index: "003" settings_override: $ref: '#/components/schemas/CallSettingsRequest' description: the settings to change for this call title: Settings Override - x-stream-index: "005" + x-stream-index: "004" starts_at: description: the time the call is scheduled to start format: date-time title: Starts At type: string - x-stream-index: "006" + x-stream-index: "005" type: object UpdateCallResponse: description: Represents a call @@ -2922,15 +2971,15 @@ components: items: type: string type: array - x-stream-index: "005" + x-stream-index: "004" revoke_permissions: items: type: string type: array - x-stream-index: "006" + x-stream-index: "005" user_id: type: string - x-stream-index: "004" + x-stream-index: "003" required: - user_id type: object @@ -3246,7 +3295,7 @@ externalDocs: url: https://getstream.io/video/docs/ info: title: Stream Video API - version: v87.2.1 + version: v87.3.0 openapi: 3.0.3 paths: /call/{type}/{id}: @@ -3261,20 +3310,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -3367,7 +3420,7 @@ paths: title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -3379,7 +3432,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -3449,12 +3502,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -3466,7 +3519,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -3475,7 +3528,7 @@ paths: schema: type: string writeOnly: true - x-stream-index: "008" + x-stream-index: "007" in: query name: connection_id requestBody: @@ -3553,7 +3606,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -3563,7 +3616,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -3573,7 +3626,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "004" + x-stream-index: "003" in: path name: session required: true @@ -3627,20 +3680,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -3701,22 +3758,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.002" in: path name: id required: true @@ -3866,12 +3925,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -3883,7 +3942,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -3942,20 +4001,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -3965,7 +4028,7 @@ paths: title: ConnectionID type: string writeOnly: true - x-stream-index: "008" + x-stream-index: "007" in: query name: connection_id requestBody: @@ -4025,12 +4088,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -4042,7 +4105,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4112,7 +4175,7 @@ paths: title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -4124,7 +4187,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4200,20 +4263,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4258,6 +4325,76 @@ paths: summary: Mute users x-stream-permissions: MuteUsers: To mute users on a call + /call/{type}/{id}/pin: + post: + description: | + Pins a track for all users in the call. + + Required permissions: + - PinCallTrack + operationId: VideoPin + parameters: + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.001" + in: path + name: type + required: true + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.002" + in: path + name: id + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PinRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PinResponse' + description: Successful response + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Bad request + "429": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Too many requests + headers: + X-RateLimit-Limit: + description: The number of allowed requests in the current period + schema: + type: integer + X-RateLimit-Remaining: + description: The number of remaining requests in the current period + schema: + type: integer + X-RateLimit-Reset: + description: Timestamp when number of requests will be reset + schema: + type: integer + summary: Pin + x-stream-permissions: + PinCallTrack: "" /call/{type}/{id}/reaction: post: description: | @@ -4276,7 +4413,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true @@ -4286,7 +4423,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -4353,7 +4490,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -4363,7 +4500,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4417,20 +4554,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -4488,22 +4629,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4568,7 +4711,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -4578,7 +4721,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4632,22 +4775,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4705,22 +4850,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4774,7 +4921,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -4784,7 +4931,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4838,12 +4985,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -4855,7 +5002,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4919,7 +5066,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -4929,7 +5076,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4990,7 +5137,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -5000,7 +5147,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -5121,6 +5268,76 @@ paths: ref: '#/components/schemas/UnblockedUserEvent' x-stream-permissions: BlockUser: To block / unblock a user from a call + /call/{type}/{id}/unpin: + post: + description: | + Unpins a track for all users in the call. + + Required permissions: + - PinCallTrack + operationId: VideoUnpin + parameters: + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.001" + in: path + name: type + required: true + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.002" + in: path + name: id + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnpinRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnpinResponse' + description: Successful response + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Bad request + "429": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Too many requests + headers: + X-RateLimit-Limit: + description: The number of allowed requests in the current period + schema: + type: integer + X-RateLimit-Remaining: + description: The number of remaining requests in the current period + schema: + type: integer + X-RateLimit-Reset: + description: Timestamp when number of requests will be reset + schema: + type: integer + summary: Unpin + x-stream-permissions: + PinCallTrack: "" /call/{type}/{id}/user_permissions: post: description: | @@ -5139,7 +5356,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -5149,7 +5366,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml index 6fb9aaac..58a78624 100644 --- a/openapi/video-openapi.yaml +++ b/openapi/video-openapi.yaml @@ -1933,23 +1933,23 @@ components: data: $ref: '#/components/schemas/CallRequest' title: Data - x-stream-index: "004" + x-stream-index: "003" members_limit: format: int32 maximum: 100 type: integer - x-stream-index: "007" + x-stream-index: "006" notify: description: if provided it sends a notification event to the members for this call title: Notify type: boolean - x-stream-index: "006" + x-stream-index: "005" ring: description: if provided it sends a ring event to the members for this call title: Ring type: boolean - x-stream-index: "005" + x-stream-index: "004" type: object GetOrCreateCallResponse: nullable: true @@ -2091,35 +2091,35 @@ components: description: if true the call will be created if it doesn't exist title: Create type: boolean - x-stream-index: "003" + x-stream-index: "002" data: $ref: '#/components/schemas/CallRequest' - x-stream-index: "004" + x-stream-index: "003" location: title: Location type: string - x-stream-index: "009" + x-stream-index: "008" members_limit: format: int32 maximum: 100 title: The amount of members that should be returned type: integer - x-stream-index: "007" + x-stream-index: "006" migrating_from: description: If the participant is migrating from another SFU, then this is the ID of the previous SFU title: MigratingFrom type: string - x-stream-index: "010" + x-stream-index: "009" notify: type: boolean - x-stream-index: "006" + x-stream-index: "005" ring: description: if true and the call is created, the notification will include ring=true title: Ring type: boolean - x-stream-index: "005" + x-stream-index: "004" required: - location type: object @@ -2283,24 +2283,24 @@ components: audio: title: Audio type: boolean - x-stream-index: "006" + x-stream-index: "005" mute_all_users: type: boolean - x-stream-index: "004" + x-stream-index: "003" screenshare: title: Screenshare type: boolean - x-stream-index: "008" + x-stream-index: "007" user_ids: items: type: string title: UserIDs type: array - x-stream-index: "005" + x-stream-index: "004" video: title: Video type: boolean - x-stream-index: "007" + x-stream-index: "006" type: object MuteUsersResponse: nullable: true @@ -2366,6 +2366,7 @@ components: - join-call - join-ended-call - mute-users + - pin-for-everyone - read-call - remove-call-member - screenshare @@ -2475,6 +2476,30 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + PinRequest: + nullable: true + properties: + session_id: + type: string + x-stream-index: "003" + user_id: + type: string + x-stream-index: "002" + required: + - user_id + - session_id + type: object + PinResponse: + nullable: true + properties: + duration: + description: Duration of the request in human-readable format + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object QueryCallsRequest: nullable: true properties: @@ -2532,33 +2557,33 @@ components: filter_conditions: additionalProperties: {} type: object - x-stream-index: "003" + x-stream-index: "002" id: maxLength: 64 type: string - x-stream-index: "002" + x-stream-index: "001.002" limit: format: int32 maximum: 25 minimum: 0 type: integer - x-stream-index: "005.001" + x-stream-index: "004.001" next: type: string - x-stream-index: "005.002" + x-stream-index: "004.002" prev: type: string - x-stream-index: "005.003" + x-stream-index: "004.003" sort: items: $ref: '#/components/schemas/SortParamRequest' maximum: 1 type: array - x-stream-index: "004" + x-stream-index: "003" type: maxLength: 64 type: string - x-stream-index: "001" + x-stream-index: "001.001" required: - type - id @@ -2685,7 +2710,7 @@ components: type: string title: Permissions type: array - x-stream-index: "004" + x-stream-index: "003" required: - permissions type: object @@ -2795,14 +2820,14 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "004.003" + x-stream-index: "003.003" emoji_code: type: string - x-stream-index: "004.002" + x-stream-index: "003.002" type: maxLength: 64 type: string - x-stream-index: "004.001" + x-stream-index: "003.001" required: - type type: object @@ -3066,6 +3091,30 @@ components: x-stream-event-call-type: true x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UnpinRequest: + nullable: true + properties: + session_id: + type: string + x-stream-index: "003" + user_id: + type: string + x-stream-index: "002" + required: + - user_id + - session_id + type: object + UnpinResponse: + nullable: true + properties: + duration: + description: Duration of the request in human-readable format + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object UpdateCallMembersRequest: nullable: true properties: @@ -3076,7 +3125,7 @@ components: maximum: 100 title: Remove Members type: array - x-stream-index: "004" + x-stream-index: "003" update_members: description: List of members to update or insert items: @@ -3084,7 +3133,7 @@ components: maximum: 100 title: Update Members type: array - x-stream-index: "005" + x-stream-index: "004" type: object UpdateCallMembersResponse: nullable: true @@ -3111,18 +3160,18 @@ components: description: Custom data for this object title: Custom data type: object - x-stream-index: "004" + x-stream-index: "003" settings_override: $ref: '#/components/schemas/CallSettingsRequest' description: the settings to change for this call title: Settings Override - x-stream-index: "005" + x-stream-index: "004" starts_at: description: the time the call is scheduled to start format: date-time title: Starts At type: string - x-stream-index: "006" + x-stream-index: "005" type: object UpdateCallResponse: description: Represents a call @@ -3223,15 +3272,15 @@ components: items: type: string type: array - x-stream-index: "005" + x-stream-index: "004" revoke_permissions: items: type: string type: array - x-stream-index: "006" + x-stream-index: "005" user_id: type: string - x-stream-index: "004" + x-stream-index: "003" required: - user_id type: object @@ -3559,7 +3608,7 @@ externalDocs: url: https://getstream.io/video/docs/ info: title: Stream Video API - version: v87.2.1 + version: v87.3.0 openapi: 3.0.3 paths: /call/{type}/{id}: @@ -3574,20 +3623,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -3680,7 +3733,7 @@ paths: title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -3692,7 +3745,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -3762,12 +3815,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -3779,7 +3832,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -3788,7 +3841,7 @@ paths: schema: type: string writeOnly: true - x-stream-index: "008" + x-stream-index: "007" in: query name: connection_id requestBody: @@ -3866,7 +3919,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -3876,7 +3929,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -3886,7 +3939,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "004" + x-stream-index: "003" in: path name: session required: true @@ -3940,20 +3993,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -4014,22 +4071,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.002" in: path name: id required: true @@ -4179,12 +4238,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -4196,7 +4255,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4255,20 +4314,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -4278,7 +4341,7 @@ paths: title: ConnectionID type: string writeOnly: true - x-stream-index: "008" + x-stream-index: "007" in: query name: connection_id requestBody: @@ -4338,12 +4401,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -4355,7 +4418,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4425,7 +4488,7 @@ paths: title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -4437,7 +4500,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4513,20 +4576,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -4571,6 +4638,76 @@ paths: summary: Mute users x-stream-permissions: MuteUsers: To mute users on a call + /call/{type}/{id}/pin: + post: + description: | + Pins a track for all users in the call. + + Required permissions: + - PinCallTrack + operationId: VideoPin + parameters: + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.001" + in: path + name: type + required: true + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.002" + in: path + name: id + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PinRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PinResponse' + description: Successful response + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Bad request + "429": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Too many requests + headers: + X-RateLimit-Limit: + description: The number of allowed requests in the current period + schema: + type: integer + X-RateLimit-Remaining: + description: The number of remaining requests in the current period + schema: + type: integer + X-RateLimit-Reset: + description: Timestamp when number of requests will be reset + schema: + type: integer + summary: Pin + x-stream-permissions: + PinCallTrack: "" /call/{type}/{id}/reaction: post: description: | @@ -4589,7 +4726,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true @@ -4599,7 +4736,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -4666,7 +4803,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -4676,7 +4813,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4730,20 +4867,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 + title: Type type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 + title: ID type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.002" in: path name: id required: true @@ -4801,22 +4942,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4881,7 +5024,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -4891,7 +5034,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -4945,22 +5088,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -5018,22 +5163,24 @@ paths: - content: application/json: schema: + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true - content: application/json: schema: + description: Call ID maxLength: 64 title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -5087,7 +5234,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -5097,7 +5244,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -5151,12 +5298,12 @@ paths: - content: application/json: schema: - description: Call type + description: The type of call maxLength: 64 title: Type type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -5168,7 +5315,7 @@ paths: title: ID type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true @@ -5232,7 +5379,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -5242,7 +5389,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -5303,7 +5450,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001.001" in: path name: type required: true @@ -5313,7 +5460,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "001.002" in: path name: id required: true @@ -5434,6 +5581,76 @@ paths: ref: '#/components/schemas/UnblockedUserEvent' x-stream-permissions: BlockUser: To block / unblock a user from a call + /call/{type}/{id}/unpin: + post: + description: | + Unpins a track for all users in the call. + + Required permissions: + - PinCallTrack + operationId: VideoUnpin + parameters: + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.001" + in: path + name: type + required: true + - content: + application/json: + schema: + maxLength: 64 + type: string + writeOnly: true + x-stream-index: "001.002" + in: path + name: id + required: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnpinRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnpinResponse' + description: Successful response + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Bad request + "429": + content: + application/json: + schema: + $ref: '#/components/schemas/APIError' + description: Too many requests + headers: + X-RateLimit-Limit: + description: The number of allowed requests in the current period + schema: + type: integer + X-RateLimit-Remaining: + description: The number of remaining requests in the current period + schema: + type: integer + X-RateLimit-Reset: + description: Timestamp when number of requests will be reset + schema: + type: integer + summary: Unpin + x-stream-permissions: + PinCallTrack: "" /call/{type}/{id}/user_permissions: post: description: | @@ -5452,7 +5669,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "002.001" in: path name: type required: true @@ -5462,7 +5679,7 @@ paths: maxLength: 64 type: string writeOnly: true - x-stream-index: "003" + x-stream-index: "002.002" in: path name: id required: true