Skip to content

Commit

Permalink
Update video openapi Spec (#284)
Browse files Browse the repository at this point in the history
Co-authored-by: GH Action CI Stream <[email protected]>
  • Loading branch information
stream-ci-bot and stream-ci-zz authored Oct 29, 2023
1 parent 5b36f02 commit 89d0484
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 16 deletions.
145 changes: 131 additions & 14 deletions openapi/chat-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ components:
properties:
agora_options:
$ref: '#/components/schemas/Config'
x-stream-index: "001.035"
x-stream-index: "001.038"
async_url_enrich_enabled:
type: boolean
x-stream-index: "001.016"
Expand All @@ -229,11 +229,11 @@ components:
x-stream-index: "001.006"
campaign_enabled:
type: boolean
x-stream-index: "001.029"
x-stream-index: "001.032"
cdn_expiration_seconds:
format: int32
type: integer
x-stream-index: "001.033"
x-stream-index: "001.036"
channel_configs:
additionalProperties:
$ref: '#/components/schemas/ChannelConfig'
Expand All @@ -257,22 +257,22 @@ components:
x-stream-index: "001.021"
file_upload_config:
$ref: '#/components/schemas/FileUploadConfig'
x-stream-index: "001.025"
x-stream-index: "001.028"
geofences:
items:
$ref: '#/components/schemas/GeofenceResponse'
type: array
x-stream-index: "001.037"
x-stream-index: "001.040"
grants:
additionalProperties:
items:
type: string
type: array
type: object
x-stream-index: "001.028"
x-stream-index: "001.031"
hms_options:
$ref: '#/components/schemas/Config'
x-stream-index: "001.036"
x-stream-index: "001.039"
image_moderation_enabled:
type: boolean
x-stream-index: "001.015"
Expand All @@ -283,7 +283,7 @@ components:
x-stream-index: "001.017"
image_upload_config:
$ref: '#/components/schemas/FileUploadConfig'
x-stream-index: "001.026"
x-stream-index: "001.029"
multi_tenant_enabled:
type: boolean
x-stream-index: "001.014"
Expand All @@ -309,11 +309,11 @@ components:
reminders_interval:
format: int32
type: integer
x-stream-index: "001.032"
x-stream-index: "001.035"
revoke_tokens_issued_before:
format: date-time
type: string
x-stream-index: "001.027"
x-stream-index: "001.030"
search_backend:
description: Backend implementation used for search
enum:
Expand All @@ -322,7 +322,16 @@ components:
- disabled
title: Search Backend
type: string
x-stream-index: "001.030"
x-stream-index: "001.033"
sns_key:
type: string
x-stream-index: "001.026"
sns_secret:
type: string
x-stream-index: "001.027"
sns_topic_arn:
type: string
x-stream-index: "001.025"
sqs_key:
type: string
x-stream-index: "001.023"
Expand All @@ -345,12 +354,12 @@ components:
x-stream-index: "001.013"
video_provider:
type: string
x-stream-index: "001.034"
x-stream-index: "001.037"
webhook_events:
items:
type: string
type: array
x-stream-index: "001.031"
x-stream-index: "001.034"
webhook_url:
type: string
x-stream-index: "001.004"
Expand All @@ -376,6 +385,9 @@ components:
- sqs_url
- sqs_key
- sqs_secret
- sns_topic_arn
- sns_key
- sns_secret
- file_upload_config
- image_upload_config
- grants
Expand Down Expand Up @@ -10164,6 +10176,70 @@ components:
- target_id
- target_ids
type: object
UnreadCountsChannel:
properties:
channel_id:
type: string
x-stream-index: "001"
last_read:
format: date-time
type: string
x-stream-index: "003"
unread_count:
format: int32
type: integer
x-stream-index: "002"
required:
- channel_id
- unread_count
- last_read
type: object
UnreadCountsChannelType:
properties:
channel_count:
format: int32
type: integer
x-stream-index: "002"
channel_type:
type: string
x-stream-index: "001"
unread_count:
format: int32
type: integer
x-stream-index: "003"
required:
- channel_type
- channel_count
- unread_count
type: object
UnreadCountsResponse:
nullable: true
properties:
channel_type:
items:
$ref: '#/components/schemas/UnreadCountsChannelType'
type: array
x-stream-index: "003"
channels:
items:
$ref: '#/components/schemas/UnreadCountsChannel'
type: array
x-stream-index: "002"
duration:
description: Duration of the request in human-readable format
title: Duration
type: string
x-stream-index: "004.001"
total_unread_count:
format: int32
type: integer
x-stream-index: "001"
required:
- total_unread_count
- channels
- channel_type
- duration
type: object
UpdateAppRequest:
nullable: true
properties:
Expand Down Expand Up @@ -11801,7 +11877,7 @@ externalDocs:
url: https://getstream.io/chat/docs/
info:
title: Stream Chat API
version: v89.12.0
version: v89.13.0
openapi: 3.0.3
paths:
/app:
Expand Down Expand Up @@ -17363,6 +17439,47 @@ paths:
- Tasks
x-stream-docs-page-id: tasks
x-stream-server-side: true
/unread:
get:
description: |
UnreadCount counts
operationId: UnreadCounts
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/UnreadCountsResponse'
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: UnreadCount counts
tags:
- Channels
x-stream-docs-page-id: unread_counts
/users:
get:
description: |
Expand Down
2 changes: 1 addition & 1 deletion openapi/video-openapi-clientside.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3447,7 +3447,7 @@ externalDocs:
url: https://getstream.io/video/docs/
info:
title: Stream Video API
version: v89.12.0
version: v89.13.0
openapi: 3.0.3
paths:
/call/{type}/{id}:
Expand Down
2 changes: 1 addition & 1 deletion openapi/video-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3832,7 +3832,7 @@ externalDocs:
url: https://getstream.io/video/docs/
info:
title: Stream Video API
version: v89.12.0
version: v89.13.0
openapi: 3.0.3
paths:
/call/{type}/{id}:
Expand Down

0 comments on commit 89d0484

Please sign in to comment.