Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update video openapi Spec #444

Closed
wants to merge 1 commit into from
Closed

Update video openapi Spec #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8565,7 +8565,7 @@ components:
type: apiKey
info:
title: Stream API
version: v98.2.0
version: v98.2.0-fix-transcriptions.14
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9691,7 +9691,7 @@ components:
type: apiKey
info:
title: Stream API
version: v98.2.0
version: v98.2.0-fix-transcriptions.14
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/clientside-api.json
View file
Open in desktop

Large diffs are not rendered by default.

102 changes: 101 additions & 1 deletion openapi/clientside-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2032,6 +2032,33 @@ components:
- members
- own_capabilities
type: object
CallTranscription:
description: CallTranscription represents a transcription of a call.
properties:
end_time:
format: date-time
title: The end time of the transcription.
type: string
x-stream-index: "004"
filename:
title: The filename of the transcription.
type: string
x-stream-index: "001"
start_time:
format: date-time
title: The start time of the transcription.
type: string
x-stream-index: "003"
url:
title: The URL of the transcription.
type: string
x-stream-index: "002"
required:
- filename
- url
- start_time
- end_time
type: object
CallType:
nullable: true
properties:
Expand Down Expand Up @@ -4588,6 +4615,9 @@ components:
x-stream-index: "004"
start_transcription:
type: boolean
x-stream-index: "007"
transcription_storage_name:
type: string
x-stream-index: "006"
type: object
GoLiveResponse:
Expand Down Expand Up @@ -5160,6 +5190,21 @@ components:
- duration
- recordings
type: object
ListTranscriptionsResponse:
nullable: true
properties:
duration:
type: string
x-stream-index: "001.001"
transcriptions:
items:
$ref: '#/components/schemas/CallTranscription'
type: array
x-stream-index: "002"
required:
- duration
- transcriptions
type: object
MarkChannelsReadRequest:
nullable: true
properties:
Expand Down Expand Up @@ -8804,6 +8849,10 @@ components:
type: object
StartTranscriptionRequest:
nullable: true
properties:
transcription_external_storage:
type: string
x-stream-index: "002"
type: object
StartTranscriptionResponse:
nullable: true
Expand Down Expand Up @@ -11275,7 +11324,7 @@ components:
type: apiKey
info:
title: Stream API
version: v98.2.0
version: v98.2.0-fix-transcriptions.14
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down Expand Up @@ -15116,6 +15165,12 @@ paths:
type: string
writeOnly: true
x-stream-index: "001.002"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartTranscriptionRequest'
required: true
responses:
"201":
content:
Expand Down Expand Up @@ -15326,6 +15381,51 @@ paths:
$ref: '#/components/schemas/APIError'
description: Too many requests
summary: Stop transcription
/api/v2/video/call/{type}/{id}/transcriptions:
get:
description: |
Lists transcriptions

Required permissions:
- ListTranscriptions
operationId: ListTranscriptions
parameters:
- in: path
name: type
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.001"
- in: path
name: id
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.002"
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ListTranscriptionsResponse'
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
summary: List transcriptions
/api/v2/video/call/{type}/{id}/unblock:
post:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/serverside-api.json
View file
Open in desktop

Large diffs are not rendered by default.

102 changes: 101 additions & 1 deletion openapi/serverside-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1265,6 +1265,33 @@ components:
- members
- own_capabilities
type: object
CallTranscription:
description: CallTranscription represents a transcription of a call.
properties:
end_time:
format: date-time
title: The end time of the transcription.
type: string
x-stream-index: "004"
filename:
title: The filename of the transcription.
type: string
x-stream-index: "001"
start_time:
format: date-time
title: The start time of the transcription.
type: string
x-stream-index: "003"
url:
title: The URL of the transcription.
type: string
x-stream-index: "002"
required:
- filename
- url
- start_time
- end_time
type: object
CallType:
nullable: true
properties:
Expand Down Expand Up @@ -5014,6 +5041,9 @@ components:
x-stream-index: "004"
start_transcription:
type: boolean
x-stream-index: "007"
transcription_storage_name:
type: string
x-stream-index: "006"
type: object
GoLiveResponse:
Expand Down Expand Up @@ -5769,6 +5799,21 @@ components:
- roles
- duration
type: object
ListTranscriptionsResponse:
nullable: true
properties:
duration:
type: string
x-stream-index: "001.001"
transcriptions:
items:
$ref: '#/components/schemas/CallTranscription'
type: array
x-stream-index: "002"
required:
- duration
- transcriptions
type: object
MarkChannelsReadRequest:
nullable: true
properties:
Expand Down Expand Up @@ -8940,6 +8985,10 @@ components:
type: object
StartTranscriptionRequest:
nullable: true
properties:
transcription_external_storage:
type: string
x-stream-index: "002"
type: object
StartTranscriptionResponse:
nullable: true
Expand Down Expand Up @@ -11439,7 +11488,7 @@ components:
type: apiKey
info:
title: Stream API
version: v98.2.0
version: v98.2.0-fix-transcriptions.14
openapi: 3.0.3
paths:
/api/v2/app:
Expand Down Expand Up @@ -16483,6 +16532,12 @@ paths:
type: string
writeOnly: true
x-stream-index: "001.002"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartTranscriptionRequest'
required: true
responses:
"201":
content:
Expand Down Expand Up @@ -16693,6 +16748,51 @@ paths:
$ref: '#/components/schemas/APIError'
description: Too many requests
summary: Stop transcription
/api/v2/video/call/{type}/{id}/transcriptions:
get:
description: |
Lists transcriptions

Required permissions:
- ListTranscriptions
operationId: ListTranscriptions
parameters:
- in: path
name: type
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.001"
- in: path
name: id
required: true
schema:
maxLength: 64
type: string
writeOnly: true
x-stream-index: "001.002"
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ListTranscriptionsResponse'
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
summary: List transcriptions
/api/v2/video/call/{type}/{id}/unblock:
post:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/video-openapi-clientside.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading