Shrek App 1.0.0

Purpose of this app is to have some fun with AsyncAPI and WebSocket and define an interface for ... Shrek.

You can use this API to chat with Shrek bot or to get updates about artifical travels to different locations.

Servers

localhost ws

Operations

Pub /chat

Client can send chat messages.

Accepts the following message:

chatMessage

Message that you send or receive from chat

Payload
string

Examples

chatMessage
Payload
"string"
This example has been generated automatically.

Sub /chat

Client can receive chat messages.

Accepts the following message:

chatMessage

Message that you send or receive from chat

Payload
string

Examples

chatMessage
Payload
"string"
This example has been generated automatically.

Sub /travel/status

Client can receive travel info status.

Accepts the following message:

travelInfo

Message that contains information about travel status.

Payload
object
destination
string

Name of travel destination.

distance
string

How much distance left to the target.

arrival
string

Time left to get there.

Additional properties are allowed.

Examples

travelInfo
Payload
Example #1
{
  "destination": "Far far away",
  "distance": "Beyond the seven mountains and seven forests",
  "arrival": "Pretty soon"
}

Messages

#1 chatMessage

Message that you send or receive from chat

Payload
string
#2 travelInfo

Message that contains information about travel status.

Payload
object
destination
string

Name of travel destination.

distance
string

How much distance left to the target.

arrival
string

Time left to get there.

Additional properties are allowed.