missingparts.schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "definitions": {
        "card": {
            "title": "Card",
            "description": "A playing card",
            "type": "object",
            "properties": {
                "suit": {
                    "oneOf": [
                        {
                            "const": "Clubs"
                        },
                        {
                            "const": "Diamonds"
                        },
                        {
                            "const": "Hearts"
                        },
                        {
                            "const": "Spades"
                        }
                    ]
                },
                "rank": {
                    "oneOf": [
                        {
                            "const": "Ace"
                        },
                        {
                            "const": "Two"
                        },
                        {
                            "const": "Three"
                        },
                        {
                            "const": "Four"
                        },
                        {
                            "const": "Five"
                        },
                        {
                            "const": "Six"
                        },
                        {
                            "const": "Seven"
                        },
                        {
                            "const": "Eight"
                        },
                        {
                            "const": "Nine"
                        },
                        {
                            "const": "Ten"
                        },
                        {
                            "const": "Jack"
                        },
                        {
                            "const": "Queen"
                        },
                        {
                            "const": "King"
                        }
                    ]
                }
            },
            "required": [
                "suit",
                "rank"
            ]
        },
        "join_lobby_request": {
            "title": "Join Lobby Request",
            "description": "Indicate to the server what kind of game the client wants to join",
            "type": "object",
            "properties": {
                "min_game_size": {
                    "description": "The game that the client wants to join will have minimum this many players",
                    "type": "integer"
                },
                "max_game_size": {
                    "description": "The game that the client wants to join will have maximum this many players",
                    "type": "integer"
                }
            },
            "required": [
                "min_game_size",
                "max_game_size"
            ]
        },
        "player_private_response": {
            "title": "Player Private Info Response",
            "description": "Contains the secret information of the player. Sent as a response to the player private info request.",
            "type": "object",
            "properties": {
                "missing_part": {
                    "description": "The part that the player needs to gather in the game in order to win.",
                    "$ref": "#/definitions/card"
                }
            },
            "required": [
                "missing_part"
            ]
        },
        "token": {
            "type": "string",
            "description": "The secret code that the client must send as the value of the \"Authorization\" header when querying the lobby status, making moves, or querying the private info of the player"
        },
        "game_id": {
            "type": "integer",
            "description": "An identifier for a game"
        },
        "player_id_in_game": {
            "type": "integer",
            "description": "Identifies a player in a game"
        },
        "player_id_in_lobby": {
            "type": "integer",
            "description": "Identifies a player in the lobby"
        },
        "player_joined_lobby": {
            "title": "Player Joined the Lobby",
            "description": "Contains the player's token and lobby ID. Sent as a response to the lobby join request, if the player did not directly join a game.",
            "type": "object",
            "properties": {
                "token": {
                    "$ref": "#/definitions/token"
                },
                "player_id_in_lobby": {
                    "$ref": "#/definitions/player_id_in_lobby"
                }
            },
            "required": [
                "token",
                "player_id_in_lobby"
            ]
        },
        "player_joined_game_directly": {
            "title": "Player Joined a Game",
            "description": "The player wanted to join the lobby, but they directly joined a game.",
            "type": "object",
            "properties": {
                "token": {
                    "$ref": "#/definitions/token"
                },
                "game_id": {
                    "$ref": "#/definitions/game_id"
                },
                "player_id_in_game": {
                    "$ref": "#/definitions/player_id_in_game"
                }
            },
            "required": [
                "token",
                "game_id",
                "player_id_in_game"
            ]
        },
        "join_lobby_response": {
            "description": "Sent as a response to the join lobby request.",
            "oneOf": [
                {
                    "$ref": "#/definitions/player_joined_lobby"
                },
                {
                    "$ref": "#/definitions/player_joined_game_directly"
                }
            ]
        },
        "found_game_response": {
            "title": "Found Game Response",
            "description": "Sent as a response to the get game request for a lobby player",
            "type": "object",
            "properties": {
                "game_id": {
                    "$ref": "#/definitions/game_id"
                },
                "player_id_in_game": {
                    "$ref": "#/definitions/player_id_in_game"
                }
            },
            "required": [
                "game_id",
                "player_id_in_game"
            ]
        },
        "trade_offer": {
            "type": "object",
            "properties": {
                "offered": {
                    "description": "the card that is being offered. If the trade is approved, this card will go from the initiating player to the trade recipient.",
                    "$ref": "#/definitions/card"
                },
                "in_exchange": {
                    "description": "the card that is being asked for. If the trade is approved, this card will go from the trade recipient to the initiating player.",
                    "$ref": "#/definitions/card"
                }
            },
            "required": [
                "offered",
                "in_exchange"
            ]
        },
        "player_description": {
            "type": "object",
            "properties": {
                "gathered_parts": {
                    "description": "the cards that the player has",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/card"
                    }
                },
                "escaped": {
                    "description": "true if the player has escaped, false otherwise",
                    "type": "boolean"
                },
                "moves_left": {
                    "description": "how many moves the player has left. If missing (or null) they have infinite moves left, otherwise the specified number. 0 means the player is out of moves.",
                    "oneOf": [
                        {
                            "type": "null"
                        },
                        {
                            "type": "integer",
                            "minimum": 0
                        }
                    ]
                }
            },
            "required": [
                "gathered_parts",
                "escaped"
            ]
        },
        "game_state_waiting_for_player_action": {
            "title": "Waiting for Player Action",
            "description": "the game waiting for the given player to take any turn action",
            "type": "object",
            "properties": {
                "WaitingForPlayerAction": {
                    "type": "object",
                    "description": "the player who needs to take a turn action to advance the game",
                    "properties": {
                        "player": {
                            "$ref": "#/definitions/player_id_in_game"
                        }
                    },
                    "required": [
                        "player"
                    ]
                }
            },
            "required": [
                "WaitingForPlayerAction"
            ]
        },
        "game_state_waiting_for_scavenge_complete": {
            "title": "Waiting for Scavenge Complete",
            "description": "the game is waiting for the given player to complete the Scavenge action by choosing one of the cards to keep",
            "type": "object",
            "properties": {
                "WaitingForScavengeComplete": {
                    "type": "object",
                    "properties": {
                        "player": {
                            "description": "the player who needs to finish the Scavenge action",
                            "$ref": "#/definitions/player_id_in_game"
                        },
                        "scavenged_cards": {
                            "type": "array",
                            "description": "the cards that the Scavenge action unearthed. One of these must be chosen by the player to keep to finish the Scavenge",
                            "items": {
                                "$ref": "#/definitions/card"
                            }
                        }
                    },
                    "required": [
                        "player",
                        "scavenged_cards"
                    ]
                }
            },
            "required": [
                "WaitingForScavengeComplete"
            ]
        },
        "game_state_waiting_for_trade_confirmation": {
            "title": "Waiting for Trade Confirmation",
            "description": "the game is waiting for a player who was a party of a Trade action to approve or reject the trade",
            "type": "object",
            "properties": {
                "WaitingForTradeConfirmation": {
                    "type": "object",
                    "properties": {
                        "initiating_player": {
                            "description": "the player who initiated the trade",
                            "$ref": "#/definitions/player_id_in_game"
                        },
                        "trading_with_player": {
                            "description": "the player who received the trade offer. This player must approve or reject the trade",
                            "$ref": "#/definitions/player_id_in_game"
                        },
                        "offer": {
                            "$ref": "#/definitions/trade_offer"
                        }
                    },
                    "required": [
                        "initiating_player",
                        "trading_with_player",
                        "offer"
                    ]
                }
            },
            "required": [
                "WaitingForTradeConfirmation"
            ]
        },
        "game_state_finished": {
            "title": "Finished",
            "description": "The game has finished, none of the players can make any more moves",
            "const": "Finished"
        },
        "game_state": {
            "description": "The game's core state, which determined which are the valid moves the next player can take",
            "oneOf": [
                {
                    "$ref": "#/definitions/game_state_finished"
                },
                {
                    "$ref": "#/definitions/game_state_waiting_for_player_action"
                },
                {
                    "$ref": "#/definitions/game_state_waiting_for_scavenge_complete"
                },
                {
                    "$ref": "#/definitions/game_state_waiting_for_trade_confirmation"
                }
            ]
        },
        "game_description": {
            "title": "Game Description",
            "description": "Describes the public state of the game. This is what all players and spectators can see.",
            "type": "object",
            "properties": {
                "num_cards_in_draw": {
                    "description": "How many cards are there in the draw pile",
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 52
                },
                "discard": {
                    "description": "the cards in the discard pile",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/card"
                    }
                },
                "players": {
                    "description": "the players in the game. The array is indexed by the player identifiers",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/player_description"
                    }
                },
                "state": {
                    "$ref": "#/definitions/game_state"
                }
            },
            "required": [
                "num_cards_in_draw",
                "discard",
                "players",
                "state"
            ]
        },
        "player_action": {
            "title": "Player Action",
            "description": "An action that a player can take when it's their turn, or to complete an in-progress action.",
            "oneOf": [
                {
                    "title": "Scavenge",
                    "description": "Draw 3 cards from the draw pile, and choose one to keep. The other 2 go into the discard",
                    "const": "Scavenge"
                },
                {
                    "title": "Finish Scavenge",
                    "description": "This action can only be used when a scavenge is in progress, to choose the card to keep. This card must be one of the scavenged cards indicated in the game state",
                    "type": "object",
                    "properties": {
                        "FinishScavenge": {
                            "type": "object",
                            "properties": {
                                "card": {
                                    "description": "The card to pick from the scavenged cards to keep",
                                    "$ref": "#/definitions/card"
                                }
                            },
                            "required": [
                                "card"
                            ]
                        }
                    },
                    "required": [
                        "FinishScavenge"
                    ]
                },
                {
                    "title": "Share",
                    "description": "Draw 3 cards from the pile. The top 2 will go to this player, the 3rd one will go to the selected other player.",
                    "type": "object",
                    "properties": {
                        "Share": {
                            "type": "object",
                            "properties": {
                                "with_player": {
                                    "description": "The player who should receive one card",
                                    "$ref": "#/definitions/player_id_in_game"
                                }
                            },
                            "required": [
                                "with_player"
                            ]
                        }
                    },
                    "required": [
                        "Share"
                    ]
                },
                {
                    "title": "Trade",
                    "description": "Trade a card 1:1 with another player. The other player must accept the offer. If they reject the offer, the initiating player can choose another action to take.",
                    "type": "object",
                    "properties": {
                        "Trade": {
                            "type": "object",
                            "properties": {
                                "with_player": {
                                    "description": "The recipient of the trade",
                                    "$ref": "#/definitions/player_id_in_game"
                                },
                                "offer": {
                                    "description": "The offer given to the recipient player",
                                    "$ref": "#/definitions/trade_offer"
                                }
                            },
                            "required": [
                                "with_player",
                                "offer"
                            ]
                        }
                    },
                    "required": [
                        "Trade"
                    ]
                },
                {
                    "title": "Accept Trade Offer",
                    "description": "When another player offers a trade, this action can be taken by the target player to accept the offer. The offer is indicated in the game state",
                    "const": "TradeAccept"
                },
                {
                    "title": "Reject Trade Offer",
                    "description": "When another player offers a trade, this action can be taken by the target player to reject the offer. The offer is indicated in the game state",
                    "const": "TradeReject"
                },
                {
                    "title": "Steal",
                    "description": "Steal a card from another player",
                    "type": "object",
                    "properties": {
                        "Steal": {
                            "type": "object",
                            "properties": {
                                "from_player": {
                                    "description": "The player to steal from",
                                    "$ref": "#/definitions/player_id_in_game"
                                },
                                "card": {
                                    "description": "The card to steal from the other player",
                                    "$ref": "#/definitions/card"
                                }
                            },
                            "required": [
                                "from_player",
                                "card"
                            ]
                        }
                    },
                    "required": [
                        "Steal"
                    ]
                },
                {
                    "title": "Scrap",
                    "description": "Discard any 4 cards from the player's gathered parts, and pick another card from the discard pile",
                    "type": "object",
                    "properties": {
                        "Scrap": {
                            "type": "object",
                            "properties": {
                                "player_cards": {
                                    "description": "the cards to be discarded",
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/definitions/card"
                                    }
                                },
                                "for_discard_card": {
                                    "description": "The card to take from the discard pile",
                                    "$ref": "#/definitions/card"
                                }
                            },
                            "required": [
                                "player_cards",
                                "for_discard_card"
                            ]
                        }
                    },
                    "required": [
                        "Scrap"
                    ]
                },
                {
                    "title": "Escape",
                    "description": "Ecape from the scrapyard. This can be done if the player has satisfied the escape condition",
                    "const": "Escape"
                },
                {
                    "title": "Skip",
                    "description": "Do not take any action, advance to the next player",
                    "const": "Skip"
                },
                {
                    "title": "Cheat: get Cards",
                    "description": "Add the specified cards to the player's gathered parts. This action can be only taken by test players. Note that this can introduce duplicate cards in the game",
                    "type": "object",
                    "properties": {
                        "CheatGetCards": {
                            "type": "object",
                            "properties": {
                                "cards": {
                                    "description": "the cards to add to the player's gathered parts.",
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/definitions/card"
                                    }
                                }
                            },
                            "required": [
                                "cards"
                            ]
                        }
                    },
                    "required": [
                        "CheatGetCards"
                    ]
                }
            ]
        }
    },
    "oneOf": [
        {
            "$ref": "#/definitions/player_private_response"
        },
        {
            "$ref": "#/definitions/join_lobby_response"
        },
        {
            "$ref": "#/definitions/found_game_response"
        },
        {
            "$ref": "#/definitions/game_description"
        },
        {
            "$ref": "#/definitions/player_action"
        }
    ]
}