Feline 1.0 documentation

Feline 1.0

application/json

Feline server description here

Servers

ws://0.0.0.0:4001socket.io 4europe
Allows you to connect using the websocket protocol to our Socket.io server.

port
required
string
Secure connection (TLS) is available through port 443.

Default value:"443"
Security:
User/Password
ws://0.0.0.0:4001socket.io 4asia
Allows you to connect using the websocket protocol to our Socket.io server.

port
required
string
Secure connection (TLS) is available through port 443.

Default value:"443"
Security:
User/Password
ws://0.0.0.0:4001socket.io 4north-america
Allows you to connect using the websocket protocol to our Socket.io server.

port
required
string
Secure connection (TLS) is available through port 443.

Default value:"443"
Security:
User/Password
ws://0.0.0.0:4001socket.io 4south-america
Allows you to connect using the websocket protocol to our Socket.io server.

port
required
string
Secure connection (TLS) is available through port 443.

Default value:"443"
Security:
User/Password
ws://0.0.0.0:4001socket.io 4africa
Allows you to connect using the websocket protocol to our Socket.io server.

port
required
string
Secure connection (TLS) is available through port 443.

Default value:"443"
Security:
User/Password
ws://0.0.0.0:4001socket.io 4australia
Allows you to connect using the websocket protocol to our Socket.io server.

port
required
string
Secure connection (TLS) is available through port 443.

Default value:"443"
Security:
User/Password

Operations

PUB ws/create/feline
Accepts the following message:
FelinesGateway#createFeline
object
uid: CreateFelineDto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
oneOf
object
uid: Cat
breed
required
string
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: Lion
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
roarVolume
required
number
Additional properties are allowed.
object
uid: Tiger
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
numberOfStripes
required
number
Additional properties are allowed.
object
uid: Feline
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
Examples
{ "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c", "version": "1.0.1", "payload": { "breed": "Maine Coon", "id": 0, "name": "string", "age": 0, "gender": "male", "dominantPaw": "left", "tags": [ "string" ], "birthDatetime": "2019-08-24T14:15:22Z" }, "timestamp": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
SUB ws/create/feline
Accepts one of the following messages:
- #0oneOf demo #1
  object
  uid: FelineRto
  correlationId
  required
  string
  format: uuid
  version
  required
  string
  format: x.y.z
  required
  oneOf
  object
  uid: Cat
  breed
  required
  string
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  Additional properties are allowed.
  object
  uid: Lion
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  roarVolume
  required
  number
  Additional properties are allowed.
  object
  uid: Tiger
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  numberOfStripes
  required
  number
  Additional properties are allowed.
  object
  uid: Feline
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  Additional properties are allowed.
  timestamp
  required
  string
  format: date-time
  Additional properties are allowed.
  Examples
  { "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c", "version": "1.0.1", "payload": { "breed": "Maine Coon", "id": 0, "name": "string", "age": 0, "gender": "male", "dominantPaw": "left", "tags": [ "string" ], "birthDatetime": "2019-08-24T14:15:22Z" }, "timestamp": "2019-08-24T14:15:22Z" }
  
  This example has been generated automatically.
- #1oneOf demo #2
  object
  uid: FelineExtendedRto
  correlationId
  required
  string
  format: uuid
  version
  required
  string
  format: x.y.z
  required
  oneOf
  object
  uid: Cat
  breed
  required
  string
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  Additional properties are allowed.
  object
  uid: Lion
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  roarVolume
  required
  number
  Additional properties are allowed.
  object
  uid: Tiger
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  numberOfStripes
  required
  number
  Additional properties are allowed.
  object
  uid: Feline
  id
  required
  number
  name
  required
  string
  age
  required
  number
  gender
  required
  string
  Allowed values:
  "male"
  "female"
  dominantPaw
  required
  string
  Allowed values:
  "left"
  "right"
  required
  array<string>
  Items:
  string
  birthDatetime
  required
  string
  format: date-time
  Additional properties are allowed.
  timestamp
  required
  string
  format: date-time
  Additional properties are allowed.
  Examples
  { "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c", "version": "1.0.1", "payload": { "breed": "Maine Coon", "id": 0, "name": "string", "age": 0, "gender": "male", "dominantPaw": "left", "tags": [ "string" ], "birthDatetime": "2019-08-24T14:15:22Z" }, "timestamp": "2019-08-24T14:15:22Z" }
  
  This example has been generated automatically.
SUB ms/journal
Accepts the following message:
FelinesController#journal
object
uid: JournalingDataDto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
object
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
Examples
{ "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c", "version": "1.0.1", "payload": {}, "timestamp": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
PUB ms/create/feline
Accepts the following message:
FelinesController#createFeline
object
uid: CreateFelineDto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
oneOf
object
uid: Cat
breed
required
string
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: Lion
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
roarVolume
required
number
Additional properties are allowed.
object
uid: Tiger
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
numberOfStripes
required
number
Additional properties are allowed.
object
uid: Feline
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
Examples
{ "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c", "version": "1.0.1", "payload": { "breed": "Maine Coon", "id": 0, "name": "string", "age": 0, "gender": "male", "dominantPaw": "left", "tags": [ "string" ], "birthDatetime": "2019-08-24T14:15:22Z" }, "timestamp": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
SUB ms/create/feline
Accepts the following message:
FelinesController#createFeline
object
uid: FelineRto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
oneOf
object
uid: Cat
breed
required
string
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: Lion
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
roarVolume
required
number
Additional properties are allowed.
object
uid: Tiger
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
numberOfStripes
required
number
Additional properties are allowed.
object
uid: Feline
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
Examples
{ "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c", "version": "1.0.1", "payload": { "breed": "Maine Coon", "id": 0, "name": "string", "age": 0, "gender": "male", "dominantPaw": "left", "tags": [ "string" ], "birthDatetime": "2019-08-24T14:15:22Z" }, "timestamp": "2019-08-24T14:15:22Z" }

This example has been generated automatically.

Schemas

object
uid: Feline
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: CreateFelineDto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
oneOf
object
uid: Cat
breed
required
string
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: Lion
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
roarVolume
required
number
Additional properties are allowed.
object
uid: Tiger
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
numberOfStripes
required
number
Additional properties are allowed.
object
uid: Feline
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
object
uid: FelineRto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
oneOf
object
uid: Cat
breed
required
string
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: Lion
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
roarVolume
required
number
Additional properties are allowed.
object
uid: Tiger
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
numberOfStripes
required
number
Additional properties are allowed.
object
uid: Feline
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
object
uid: FelineExtendedRto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
oneOf
object
uid: Cat
breed
required
string
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: Lion
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
roarVolume
required
number
Additional properties are allowed.
object
uid: Tiger
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
numberOfStripes
required
number
Additional properties are allowed.
object
uid: Feline
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
object
uid: JournalingDataDto
correlationId
required
string
format: uuid
version
required
string
format: x.y.z
required
object
Additional properties are allowed.
timestamp
required
string
format: date-time
Additional properties are allowed.
object
uid: Cat
breed
required
string
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
Additional properties are allowed.
object
uid: Lion
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
roarVolume
required
number
Additional properties are allowed.
object
uid: Tiger
id
required
number
name
required
string
age
required
number
gender
required
string
Allowed values:
"male"
"female"
dominantPaw
required
string
Allowed values:
"left"
"right"
required
array<string>
Items:
string
birthDatetime
required
string
format: date-time
numberOfStripes
required
number
Additional properties are allowed.

Feline 1.0

Servers

Security:

Security:

Security:

Security:

Security:

Security:

Operations

PUB ws/create/feline

Examples

This example has been generated automatically.

SUB ws/create/feline

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

SUB ms/journal

Examples

This example has been generated automatically.

PUB ms/create/feline

Examples

This example has been generated automatically.

SUB ms/create/feline

Examples

This example has been generated automatically.

Schemas