Skip to content

Commit

Permalink
Update video openapi Spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@stream-ci-zz
stream-ci-zz committed Feb 27, 2025
1 parent 8a0981c commit a69c452
Show file tree
Hide file tree
Showing 14 changed files with 1,547 additions and 269 deletions.
2 changes: 1 addition & 1 deletion docusaurus/video/docusaurus/docs/api/video-client-openapi.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docusaurus/video/docusaurus/docs/api/video-openapi.json
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion openapi/chat-openapi-clientside.json
View file

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions openapi/chat-openapi-clientside.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3909,7 +3909,7 @@ components:
type: array
x-stream-index: "001.002"
type:
default: message.new
default: notification.thread_message_new
type: string
x-stream-index: "004.001"
user:
Expand Down Expand Up @@ -4039,7 +4039,8 @@ components:
x-stream-index: "002"
type:
enum:
- '''''regular'
- ''''''
- regular
- system
type: string
x-stream-index: "011"
Expand Down Expand Up @@ -10069,7 +10070,7 @@ components:
type: apiKey
info:
title: Stream API
version: v154.1.0
version: v159.2.0
openapi: 3.0.3
paths:
/app:
Expand Down
2 changes: 1 addition & 1 deletion openapi/chat-openapi.json
View file

Large diffs are not rendered by default.

266 changes: 153 additions & 113 deletions openapi/chat-openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,147 @@ components:
- moderation_multitenant_blocklist_enabled
- guest_user_creation_disabled
type: object
AsyncExportChannelsEvent:
nullable: true
properties:
created_at:
format: date-time
type: string
x-stream-index: "003.003"
custom:
additionalProperties: {}
type: object
x-stream-index: "003.007"
finished_at:
format: date-time
type: string
x-stream-index: "002.003"
received_at:
format: date-time
type: string
x-stream-index: "003.004"
started_at:
format: date-time
type: string
x-stream-index: "002.002"
task_id:
type: string
x-stream-index: "002.001"
type:
default: export.channels.success
type: string
x-stream-index: "003.002"
url:
type: string
x-stream-index: "001"
required:
- url
- task_id
- started_at
- finished_at
- type
- created_at
- custom
title: AsyncExportChannelsEvent
type: object
x-stream-event-client-type: true
x-stream-event-doc-group: other
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
AsyncExportErrorEvent:
nullable: true
properties:
created_at:
format: date-time
type: string
x-stream-index: "003.003"
custom:
additionalProperties: {}
type: object
x-stream-index: "003.007"
error:
type: string
x-stream-index: "001"
finished_at:
format: date-time
type: string
x-stream-index: "002.003"
received_at:
format: date-time
type: string
x-stream-index: "003.004"
started_at:
format: date-time
type: string
x-stream-index: "002.002"
task_id:
type: string
x-stream-index: "002.001"
type:
default: export.users.error
type: string
x-stream-index: "003.002"
required:
- error
- task_id
- started_at
- finished_at
- type
- created_at
- custom
title: AsyncExportErrorEvent
type: object
x-stream-event-client-type: true
x-stream-event-doc-group: other
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
AsyncExportUsersEvent:
nullable: true
properties:
created_at:
format: date-time
type: string
x-stream-index: "003.003"
custom:
additionalProperties: {}
type: object
x-stream-index: "003.007"
finished_at:
format: date-time
type: string
x-stream-index: "002.003"
received_at:
format: date-time
type: string
x-stream-index: "003.004"
started_at:
format: date-time
type: string
x-stream-index: "002.002"
task_id:
type: string
x-stream-index: "002.001"
type:
default: export.users.success
type: string
x-stream-index: "003.002"
url:
type: string
x-stream-index: "001"
required:
- url
- task_id
- started_at
- finished_at
- type
- created_at
- custom
title: AsyncExportUsersEvent
type: object
x-stream-event-client-type: true
x-stream-event-doc-group: other
x-stream-is-event: true
x-stream-ws-base-event-name: VideoEvent
AsyncModerationCallbackConfig:
properties:
mode:
Expand Down Expand Up @@ -4208,26 +4349,6 @@ components:
- task_id
- duration
type: object
ExportChannelsResult:
properties:
path:
description: S3 path of result
title: PathPrefix
type: string
x-stream-index: "002"
s3_bucket_name:
description: S3 bucket name result
title: S3 bucket name
type: string
x-stream-index: "003"
url:
description: URL of result
title: URL
type: string
x-stream-index: "001"
required:
- url
type: object
ExportUserResponse:
nullable: true
properties:
Expand Down Expand Up @@ -5123,59 +5244,6 @@ components:
- duration
title: Response
type: object
GetExportChannelsStatusResponse:
nullable: true
properties:
created_at:
description: Date/time of creation
format: date-time
title: Created at
type: string
x-stream-index: "001.003"
duration:
description: Duration of the request in milliseconds
title: Duration
type: string
x-stream-index: 001.007.001
error:
$ref: '#/components/schemas/ErrorResult'
description: Contains task error in case of failure
title: Error
x-stream-index: "003"
result:
$ref: '#/components/schemas/ExportChannelsResult'
description: Contains task result in case of success
title: ExportChannelsResult
x-stream-index: "002"
status:
description: Task status
enum:
- waiting
- pending
- running
- completed
- failed
- canceled
title: Status
type: string
x-stream-index: "001.002"
task_id:
title: Task ID
type: string
x-stream-index: "001.001"
updated_at:
description: Date/time of the last update
format: date-time
title: Updated at
type: string
x-stream-index: "001.004"
required:
- task_id
- status
- created_at
- updated_at
- duration
type: object
GetImportResponse:
description: Basic response information
nullable: true
Expand Down Expand Up @@ -6785,7 +6853,7 @@ components:
type: array
x-stream-index: "001.002"
type:
default: message.new
default: notification.thread_message_new
type: string
x-stream-index: "004.001"
user:
Expand Down Expand Up @@ -6918,7 +6986,8 @@ components:
x-stream-index: "002"
type:
enum:
- '''''regular'
- ''''''
- regular
- system
type: string
x-stream-index: "011"
Expand Down Expand Up @@ -14015,6 +14084,10 @@ components:
channel.unmuted: '#/components/schemas/ChannelUnmutedEvent'
channel.updated: '#/components/schemas/ChannelUpdatedEvent'
channel.visible: '#/components/schemas/ChannelVisibleEvent'
export.channels.error: '#/components/schemas/AsyncExportErrorEvent'
export.channels.success: '#/components/schemas/AsyncExportChannelsEvent'
export.users.error: '#/components/schemas/AsyncExportErrorEvent'
export.users.success: '#/components/schemas/AsyncExportUsersEvent'
flag.updated: '#/components/schemas/FlagUpdatedEvent'
member.added: '#/components/schemas/MemberAddedEvent'
member.removed: '#/components/schemas/MemberRemovedEvent'
Expand Down Expand Up @@ -14045,6 +14118,10 @@ components:
propertyName: type
oneOf:
- $ref: '#/components/schemas/AnyEvent'
- $ref: '#/components/schemas/AsyncExportChannelsEvent'
- $ref: '#/components/schemas/AsyncExportErrorEvent'
- $ref: '#/components/schemas/AsyncExportErrorEvent'
- $ref: '#/components/schemas/AsyncExportUsersEvent'
- $ref: '#/components/schemas/CampaignCompletedEvent'
- $ref: '#/components/schemas/CampaignStartedEvent'
- $ref: '#/components/schemas/ChannelCreatedEvent'
Expand Down Expand Up @@ -14193,7 +14270,7 @@ components:
type: apiKey
info:
title: Stream API
version: v154.1.0
version: v159.2.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -16294,43 +16371,6 @@ paths:
summary: Export channels
tags:
- product:chat
/export_channels/{id}:
get:
description: |2+

operationId: GetExportChannelsStatus
parameters:
- in: path
name: id
required: true
schema:
description: Task ID
title: ID
type: string
writeOnly: true
x-stream-index: "001"
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/GetExportChannelsStatusResponse'
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: Export channels status
tags:
- product:chat
/external_storage:
get:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/clientside-api.json
View file

Large diffs are not rendered by default.

Loading

0 comments on commit a69c452

Please sign in to comment.