-
-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
1,187 additions
and
486 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
272 changes: 143 additions & 129 deletions
272
apps/studio/src/examples/real-world/gitter-streaming.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,164 +1,178 @@ | ||
asyncapi: '2.6.0' | ||
id: 'urn:com:gitter:streaming:api' | ||
asyncapi: 3.0.0 | ||
id: 'tag:stream.gitter.im,2022:api' | ||
info: | ||
title: Gitter Streaming API | ||
version: '1.0.0' | ||
|
||
version: 1.0.0 | ||
servers: | ||
production: | ||
url: https://stream.gitter.im/v1 | ||
host: stream.gitter.im | ||
pathname: /v1 | ||
protocol: https | ||
protocolVersion: '1.1' | ||
security: | ||
- httpBearerToken: [] | ||
|
||
- $ref: '#/components/securitySchemes/httpBearerToken' | ||
channels: | ||
/rooms/{roomId}/{resource}: | ||
rooms: | ||
address: '/rooms/{roomId}/{resource}' | ||
messages: | ||
chatMessage: | ||
$ref: '#/components/messages/chatMessage' | ||
heartbeat: | ||
$ref: '#/components/messages/heartbeat' | ||
parameters: | ||
roomId: | ||
description: Id of the Gitter room. | ||
schema: | ||
type: string | ||
examples: | ||
- 53307860c3599d1de448e19d | ||
examples: | ||
- 53307860c3599d1de448e19d | ||
resource: | ||
enum: | ||
- chatMessages | ||
- events | ||
description: The resource to consume. | ||
schema: | ||
type: string | ||
enum: | ||
- chatMessages | ||
- events | ||
subscribe: | ||
bindings: | ||
http: | ||
type: response | ||
message: | ||
oneOf: | ||
- $ref: '#/components/messages/chatMessage' | ||
- $ref: '#/components/messages/heartbeat' | ||
|
||
operations: | ||
sendRoomInfo: | ||
action: send | ||
channel: | ||
$ref: '#/channels/rooms' | ||
bindings: | ||
http: | ||
method: POST | ||
messages: | ||
- $ref: '#/components/messages/chatMessage' | ||
- $ref: '#/components/messages/heartbeat' | ||
components: | ||
securitySchemes: | ||
httpBearerToken: | ||
type: http | ||
scheme: bearer | ||
messages: | ||
chatMessage: | ||
schemaFormat: 'application/schema+yaml;version=draft-07' | ||
summary: >- | ||
A message represents an individual chat message sent to a room. | ||
They are a sub-resource of a room. | ||
A message represents an individual chat message sent to a room. They are | ||
a sub-resource of a room. | ||
payload: | ||
type: object | ||
properties: | ||
id: | ||
type: string | ||
description: ID of the message. | ||
text: | ||
type: string | ||
description: Original message in plain-text/markdown. | ||
html: | ||
type: string | ||
description: HTML formatted message. | ||
sent: | ||
type: string | ||
format: date-time | ||
description: ISO formatted date of the message. | ||
fromUser: | ||
type: object | ||
description: User that sent the message. | ||
properties: | ||
id: | ||
type: string | ||
description: Gitter User ID. | ||
username: | ||
type: string | ||
description: Gitter/GitHub username. | ||
displayName: | ||
type: string | ||
description: Gitter/GitHub user real name. | ||
url: | ||
type: string | ||
description: Path to the user on Gitter. | ||
avatarUrl: | ||
type: string | ||
format: uri | ||
description: User avatar URI. | ||
avatarUrlSmall: | ||
type: string | ||
format: uri | ||
description: User avatar URI (small). | ||
avatarUrlMedium: | ||
type: string | ||
format: uri | ||
description: User avatar URI (medium). | ||
v: | ||
type: number | ||
description: Version. | ||
gv: | ||
type: string | ||
description: Stands for "Gravatar version" and is used for cache busting. | ||
unread: | ||
type: boolean | ||
description: Boolean that indicates if the current user has read the message. | ||
readBy: | ||
type: number | ||
description: Number of users that have read the message. | ||
urls: | ||
type: array | ||
description: List of URLs present in the message. | ||
items: | ||
schemaFormat: application/schema+yaml;version=draft-07 | ||
schema: | ||
type: object | ||
properties: | ||
id: | ||
type: string | ||
description: ID of the message. | ||
text: | ||
type: string | ||
format: uri | ||
mentions: | ||
type: array | ||
description: List of @Mentions in the message. | ||
items: | ||
description: Original message in plain-text/markdown. | ||
html: | ||
type: string | ||
description: HTML formatted message. | ||
sent: | ||
type: string | ||
format: date-time | ||
description: ISO formatted date of the message. | ||
fromUser: | ||
type: object | ||
description: User that sent the message. | ||
properties: | ||
screenName: | ||
id: | ||
type: string | ||
userId: | ||
description: Gitter User ID. | ||
username: | ||
type: string | ||
userIds: | ||
type: array | ||
items: | ||
type: string | ||
issues: | ||
type: array | ||
description: 'List of #Issues referenced in the message.' | ||
items: | ||
type: object | ||
properties: | ||
number: | ||
description: Gitter/GitHub username. | ||
displayName: | ||
type: string | ||
description: Gitter/GitHub user real name. | ||
url: | ||
type: string | ||
description: Path to the user on Gitter. | ||
avatarUrl: | ||
type: string | ||
format: uri | ||
description: User avatar URI. | ||
avatarUrlSmall: | ||
type: string | ||
format: uri | ||
description: User avatar URI (small). | ||
avatarUrlMedium: | ||
type: string | ||
format: uri | ||
description: User avatar URI (medium). | ||
v: | ||
type: number | ||
description: Version. | ||
gv: | ||
type: string | ||
meta: | ||
type: array | ||
description: Metadata. This is currently not used for anything. | ||
items: {} | ||
v: | ||
type: number | ||
description: Version. | ||
gv: | ||
type: string | ||
description: Stands for "Gravatar version" and is used for cache busting. | ||
description: Stands for "Gravatar version" and is used for cache busting. | ||
unread: | ||
type: boolean | ||
description: Boolean that indicates if the current user has read the message. | ||
readBy: | ||
type: number | ||
description: Number of users that have read the message. | ||
urls: | ||
type: array | ||
description: List of URLs present in the message. | ||
items: | ||
type: string | ||
format: uri | ||
mentions: | ||
type: array | ||
description: List of @Mentions in the message. | ||
items: | ||
type: object | ||
properties: | ||
screenName: | ||
type: string | ||
userId: | ||
type: string | ||
userIds: | ||
type: array | ||
items: | ||
type: string | ||
issues: | ||
type: array | ||
description: 'List of #Issues referenced in the message.' | ||
items: | ||
type: object | ||
properties: | ||
number: | ||
type: string | ||
meta: | ||
type: array | ||
description: Metadata. This is currently not used for anything. | ||
items: {} | ||
v: | ||
type: number | ||
description: Version. | ||
gv: | ||
type: string | ||
description: Stands for "Gravatar version" and is used for cache busting. | ||
bindings: | ||
http: | ||
$ref: '#/components/messageBindings/streamingHeaders' | ||
|
||
headers: | ||
type: object | ||
properties: | ||
Transfer-Encoding: | ||
type: string | ||
const: chunked | ||
Trailer: | ||
type: string | ||
const: \r\n | ||
heartbeat: | ||
schemaFormat: 'application/schema+yaml;version=draft-07' | ||
summary: Its purpose is to keep the connection alive. | ||
payload: | ||
type: string | ||
enum: ["\r\n"] | ||
schemaFormat: application/schema+yaml;version=draft-07 | ||
schema: | ||
type: string | ||
enum: | ||
- "\r\n" | ||
bindings: | ||
http: | ||
$ref: '#/components/messageBindings/streamingHeaders' | ||
|
||
messageBindings: | ||
streamingHeaders: | ||
http: | ||
headers: | ||
'Transfer-Encoding': 'chunked' | ||
Trailer: '\r\n' | ||
headers: | ||
type: object | ||
properties: | ||
Transfer-Encoding: | ||
type: string | ||
const: chunked | ||
Trailer: | ||
type: string | ||
const: \r\n |
Oops, something went wrong.