InterfaceUpdateToClient

Type: object

root type
Type: enum (of string)

Must be one of:

  • "InterfaceUpdate"

root msg

root msg anyOf CurrentRoundUpdate

CurrentRoundUpdate

Type: object

The interface is designed so that a websocket client
can connect at any time and it will recieve all information
as soon as the current round finishes.
We send a CurrentRoundUpdate during the round, when the cards change.
Even if the cards don't change, this will be updated after ~2 seconds.
When the round is finished, we send a RoundHistory.

root msg anyOf CurrentRoundUpdate type
Type: enum (of string)

Must be one of:

  • "CurrentRoundUpdate"

root msg anyOf CurrentRoundUpdate round_state

StateMachineAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state state

RoundState

Type: enum (of string)

Must be one of:

  • "DEALER_DONE"
  • "DEALER_MAYBE_DONE"
  • "DEALER_ONE_CARD"
  • "DEALER_TWO_CARDS"
  • "EMPTY"
  • "FAILED"
  • "STARTED"

root msg anyOf CurrentRoundUpdate round_state players
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI

PlayerAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI

StackAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards CardAPI

CardAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards CardAPI label

Label52

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards CardAPI label card

Card

Type: enum (of string)

Must be one of:

  • "10"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"
  • "7"
  • "8"
  • "9"
  • "A"
  • "J"
  • "K"
  • "Q"

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards CardAPI label suit

Suit

Type: enum (of string)

Must be one of:

  • "C"
  • "D"
  • "H"
  • "S"

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards CardAPI center
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards CardAPI center center item 0
Type: number
Item at 2 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI live_cards CardAPI center center item 1
Type: number

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI

ChipStackAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI center
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI center center item 0
Type: number
Item at 2 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI center center item 1
Type: number
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 1
Type: null

root msg anyOf CurrentRoundUpdate round_state anomalies
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state anomalies Anomaly

Anomaly

Type: enum (of string)

Must be one of:

  • "CARD_FAR_AWAY"
  • "DEALER_CARD_FAR_AWAY"
  • "FAILED"
  • "ONLY_DEALER_ROUND"
  • "OTHER"
  • "UNCLEAR_DECISION"
  • "UNCLEAR_DECISION_STARTED"
  • "UNCLEAR_DOUBLED"

root msg anyOf CurrentRoundUpdate round_state phase_timestamps
Type: array of array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state phase_timestamps phase_timestamps items
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root msg anyOf CurrentRoundUpdate round_state phase_timestamps phase_timestamps items RoundState

RoundState

Type: enum (of string)
Same definition as state
Item at 2 must be:
root msg anyOf CurrentRoundUpdate round_state phase_timestamps phase_timestamps items phase_timestamps items item 1
Type: string

root msg anyOf CurrentRoundUpdate licensing_info

LicensingInfo

Type: object

root msg anyOf CurrentRoundUpdate licensing_info license_type

root msg anyOf CurrentRoundUpdate licensing_info license_type anyOf item 0
Type: enum (of string)

Must be one of:

  • "Development"
root msg anyOf CurrentRoundUpdate licensing_info license_type anyOf item 1
Type: enum (of string)

Must be one of:

  • "Trial"
root msg anyOf CurrentRoundUpdate licensing_info license_type anyOf item 2
Type: enum (of string)

Must be one of:

  • "Paid"

root msg anyOf CurrentRoundUpdate licensing_info errors
Type: array of string
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate licensing_info errors errors items
Type: string
root msg anyOf RoundHistory

RoundHistory

Type: object

After a finished round we the last 100 rounds that we have cached.
This is so that any frontend can catch up with the recent history,
without requiring a database.
In the future this might not be needed if the consumer of this API
has its own database.

root msg anyOf RoundHistory type
Type: enum (of string)

Must be one of:

  • "RoundHistory"

root msg anyOf RoundHistory rounds
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf RoundHistory rounds StateMachineAPI

StateMachineAPI

Type: object
Same definition as round_state

root version
Type: string Default: "3.0"