openapi: 3.0.3 info: title: '' version: 0.0.0 paths: /api/schema/: get: operationId: api_schema_retrieve description: |- OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json parameters: - in: query name: format schema: type: string enum: - json - yaml - in: query name: lang schema: type: string enum: - af - ar - ar-dz - ast - az - be - bg - bn - br - bs - ca - ckb - cs - cy - da - de - dsb - el - en - en-au - en-gb - eo - es - es-ar - es-co - es-mx - es-ni - es-ve - et - eu - fa - fi - fr - fy - ga - gd - gl - he - hi - hr - hsb - ht - hu - hy - ia - id - ig - io - is - it - ja - ka - kab - kk - km - kn - ko - ky - lb - lt - lv - mk - ml - mn - mr - ms - my - nb - ne - nl - nn - os - pa - pl - pt - pt-br - ro - ru - sk - sl - sq - sr - sr-latn - sv - sw - ta - te - tg - th - tk - tr - tt - udm - ug - uk - ur - uz - vi - zh-hans - zh-hant tags: - api security: - jwtAuth: [] - {} responses: '200': content: application/vnd.oai.openapi: schema: type: object additionalProperties: {} application/yaml: schema: type: object additionalProperties: {} application/vnd.oai.openapi+json: schema: type: object additionalProperties: {} application/json: schema: type: object additionalProperties: {} description: '' /api/token/refresh/: post: operationId: api_token_refresh_create description: |- Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenRefresh' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TokenRefresh' description: '' /auth/apple-login/: post: operationId: auth_apple_login_create tags: - auth requestBody: content: application/json: schema: $ref: '#/components/schemas/AppleAuth' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/AppleAuth' description: '' /auth/email-login/: post: operationId: auth_email_login_create tags: - auth requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailLogin' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/EmailLogin' description: '' /auth/login/: post: operationId: auth_login_create tags: - auth requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleAuth' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/GoogleAuth' description: '' /auth/password-reset/: post: operationId: auth_password_reset_create tags: - auth requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordReset' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/PasswordReset' description: '' /auth/password-reset/confirm/: post: operationId: auth_password_reset_confirm_create tags: - auth requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordResetConfirm' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/PasswordResetConfirm' description: '' /auth/register/: post: operationId: auth_register_create tags: - auth requestBody: content: application/json: schema: $ref: '#/components/schemas/Register' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/Register' description: '' /auth/verify-email/: post: operationId: auth_verify_email_create tags: - auth requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyEmail' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/VerifyEmail' description: '' /blog/: get: operationId: blog_list description: |- Lists every blog post, newest first. The body is omitted; fetch a post by slug to read it. tags: - blog security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/BlogPostList' description: '' /blog/{slug}/: get: operationId: blog_retrieve description: Returns a single blog post by slug, including its Markdown body. parameters: - in: path name: slug schema: type: string required: true tags: - blog security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/BlogPostRetrieve' description: '' /devices/: get: operationId: devices_list tags: - devices security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FCMDevice' description: '' post: operationId: devices_create tags: - devices requestBody: content: application/json: schema: $ref: '#/components/schemas/FCMDevice' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FCMDevice' description: '' put: operationId: devices_update tags: - devices requestBody: content: application/json: schema: $ref: '#/components/schemas/FCMDevice' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FCMDevice' description: '' /game/: post: operationId: game_create tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/GameCreate' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GameCreate' description: '' /game/{game_id}/: get: operationId: game_retrieve parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/GameRetrieve' description: '' /game/{game_id}/addable-user/: get: operationId: game_addable_user_list description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AddableUser' description: '' /game/{game_id}/clone-to-sandbox/: post: operationId: game_clone_to_sandbox_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/GameCloneToSandbox' security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GameCloneToSandbox' description: '' /game/{game_id}/confirm-phase/: put: operationId: game_confirm_phase_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/PhaseState' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseState' description: '' patch: operationId: game_confirm_phase_partial_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPhaseState' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseState' description: '' /game/{game_id}/delete/: delete: operationId: game_delete_destroy description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{game_id}/extend-deadline/: put: operationId: game_extend_deadline_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/GameExtendDeadline' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GameExtendDeadline' description: '' patch: operationId: game_extend_deadline_partial_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGameExtendDeadline' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GameExtendDeadline' description: '' /game/{game_id}/kick/{member_id}/: delete: operationId: game_kick_destroy description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: member_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{game_id}/leave/: delete: operationId: game_leave_destroy description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{game_id}/member/: post: operationId: game_member_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberCreate' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{game_id}/member/{member_id}/: get: operationId: game_member_retrieve description: |- Retrieve one member's place in a game, including game masters and members who have left their seat, with the actions the requesting user can take on them. On the requesting user's own member, the actions are the game actions. parameters: - in: path name: game_id schema: type: string required: true - in: path name: member_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MemberDetail' description: '' /game/{game_id}/member/{member_id}/nation/: put: operationId: game_member_nation_update description: |- Pin a nation to a member of a pending game, or unpin it. Game master only; pinned nations are kept when the game starts. parameters: - in: path name: game_id schema: type: string required: true - in: path name: member_id schema: type: integer required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberNationAssign' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' delete: operationId: game_member_nation_destroy description: |- Pin a nation to a member of a pending game, or unpin it. Game master only; pinned nations are kept when the game starts. parameters: - in: path name: game_id schema: type: string required: true - in: path name: member_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{game_id}/member/{member_id}/rating/: get: operationId: game_member_rating_retrieve description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: member_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RatingResultOutput' description: '' /game/{game_id}/member/{member_id}/report/: post: operationId: game_member_report_create parameters: - in: path name: game_id schema: type: string required: true - in: path name: member_id schema: type: integer required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportMemberInput' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ReportOutput' description: '' /game/{game_id}/member/join/: post: operationId: game_member_join_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{game_id}/member/nation-preference/: get: operationId: game_member_nation_preference_retrieve description: |- Read or replace the requesting member's ranked nation preferences for a game that has not started. Array position determines rank; an empty list means no preference. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MemberNationPreference' description: '' put: operationId: game_member_nation_preference_update description: |- Read or replace the requesting member's ranked nation preferences for a game that has not started. Array position determines rank; an empty list means no preference. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberNationPreference' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MemberNationPreference' description: '' /game/{game_id}/member/withdraw/: put: operationId: game_member_withdraw_update description: Withdraw the requesting user from an active game, leaving their seat vacant for another player to claim. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/MemberWithdraw' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' patch: operationId: game_member_withdraw_partial_update description: Withdraw the requesting user from an active game, leaving their seat vacant for another player to claim. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMemberWithdraw' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{game_id}/members/{member_id}/replace/: post: operationId: game_members_replace_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: member_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{game_id}/muster/: post: operationId: game_muster_create description: Confirm the requesting user's seat in a mustering game. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{game_id}/options/: get: operationId: game_options_retrieve description: |- Used by views that have a game parameter in the URL. Provides a get_phase method that returns the current phase for the game. Also adds phase to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderOptionsResponse' description: '' /game/{game_id}/orders/: post: operationId: game_orders_create description: |- Used by views that have a game parameter in the URL. Provides a get_phase method that returns the current phase for the game. Also adds phase to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game requestBody: content: application/json: schema: $ref: '#/components/schemas/Order' security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Order' description: '' /game/{game_id}/orders/{phase_id}: get: operationId: game_orders_list description: |- Used by views that have a phase parameter in the URL. Provides a get_phase method that returns the phase object. Also adds phase to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: phase_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Order' description: '' /game/{game_id}/orders/delete/{source_id}: delete: operationId: game_orders_delete_destroy description: |- Used by views that have a game parameter in the URL. Provides a get_phase method that returns the current phase for the game. Also adds phase to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: source_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{game_id}/pause/: put: operationId: game_pause_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body patch: operationId: game_pause_partial_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body /game/{game_id}/phase-states/: get: operationId: game_phase_states_list description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PhaseState' description: '' /game/{game_id}/phase/{phase_id}/: get: operationId: game_phase_retrieve description: Retrieve a phase with its units, supply centers and province ownership. parameters: - in: path name: game_id schema: type: string required: true - in: path name: phase_id schema: type: integer required: true tags: - game security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseRetrieve' description: '' /game/{game_id}/phase/{phase_id}/revert/: put: operationId: game_phase_revert_update description: Revert a sandbox game to this phase, deleting every later phase. This phase's orders are kept and their results cleared. parameters: - in: path name: game_id schema: type: string required: true - in: path name: phase_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseList' description: '' patch: operationId: game_phase_revert_partial_update description: Revert a sandbox game to this phase, deleting every later phase. This phase's orders are kept and their results cleared. parameters: - in: path name: game_id schema: type: string required: true - in: path name: phase_id schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseList' description: '' /game/{game_id}/phases/: get: operationId: game_phases_list description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PhaseList' description: '' /game/{game_id}/resolve-phase/: post: operationId: game_resolve_phase_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseList' description: '' /game/{game_id}/unpause/: put: operationId: game_unpause_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body patch: operationId: game_unpause_partial_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body /games/: get: operationId: games_list parameters: - in: query name: can_join schema: type: boolean - in: query name: eligible_only schema: type: boolean - in: query name: mine schema: type: boolean - in: query name: movement_phase_duration schema: type: string nullable: true enum: - 1 hour - 1 week - 12 hours - 15 minutes - 2 hours - 2 weeks - 24 hours - 3 days - 30 minutes - 4 days - 4 hours - 48 hours - 5 minutes - 8 hours description: |- * `5 minutes` - 5 minutes * `15 minutes` - 15 minutes * `30 minutes` - 30 minutes * `1 hour` - 1 hour * `2 hours` - 2 hours * `4 hours` - 4 hours * `8 hours` - 8 hours * `12 hours` - 12 hours * `24 hours` - 24 hours * `48 hours` - 48 hours * `3 days` - 3 days * `4 days` - 4 days * `1 week` - 1 week * `2 weeks` - 2 weeks - in: query name: ordering schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: sandbox schema: type: boolean - in: query name: status schema: type: string - in: query name: variant schema: type: string tags: - games security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGameListList' description: '' /games/{game_id}/channel-previews/: get: operationId: games_channel_previews_list description: List the channels the requester can read, each with only its latest message. parameters: - in: path name: game_id schema: type: string required: true tags: - games security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ChannelPreview' description: '' /games/{game_id}/channels/{channel_id}/: get: operationId: games_channels_retrieve description: Retrieve a channel without its message history, or rename a private channel. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChannelDetail' description: '' put: operationId: games_channels_update description: Retrieve a channel without its message history, or rename a private channel. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/ChannelUpdate' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChannelUpdate' description: '' patch: operationId: games_channels_partial_update description: Retrieve a channel without its message history, or rename a private channel. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedChannelUpdate' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChannelUpdate' description: '' /games/{game_id}/channels/{channel_id}/leave/: post: operationId: games_channels_leave_create description: Leave a private channel. A member who leaves cannot rejoin. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games security: - jwtAuth: [] responses: '201': description: No response body /games/{game_id}/channels/{channel_id}/mark-read/: post: operationId: games_channels_mark_read_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games security: - jwtAuth: [] responses: '201': description: No response body /games/{game_id}/channels/{channel_id}/messages/: get: operationId: games_channels_messages_retrieve description: List a page of a channel's messages, oldest to newest, bounded by message ID with `before` or `after`. parameters: - in: query name: after schema: type: integer minimum: 1 - in: query name: before schema: type: integer minimum: 1 - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true - in: query name: page_size schema: type: integer minimum: 1 default: 50 tags: - games security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChannelMessagePage' description: '' /games/{game_id}/channels/{channel_id}/messages/create/: post: operationId: games_channels_messages_create_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/ChannelMessage' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ChannelMessage' description: '' /games/{game_id}/channels/{channel_id}/mute/: put: operationId: games_channels_mute_update description: Mute or unmute notifications for a channel. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/ChannelMute' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChannelMute' description: '' patch: operationId: games_channels_mute_partial_update description: Mute or unmute notifications for a channel. parameters: - in: path name: channel_id schema: type: integer required: true - in: path name: game_id schema: type: string required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedChannelMute' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChannelMute' description: '' /games/{game_id}/channels/create/: post: operationId: games_channels_create_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/Channel' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Channel' description: '' /games/{game_id}/draw-proposals/: get: operationId: games_draw_proposals_list description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - games security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DrawProposal' description: '' /games/{game_id}/draw-proposals/{proposal_id}/cancel/: delete: operationId: games_draw_proposals_cancel_destroy description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: proposal_id schema: type: integer required: true tags: - games security: - jwtAuth: [] responses: '204': description: No response body /games/{game_id}/draw-proposals/{proposal_id}/vote/: put: operationId: games_draw_proposals_vote_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: proposal_id schema: type: integer required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/DrawVoteUpdate' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DrawVoteUpdate' description: '' patch: operationId: games_draw_proposals_vote_partial_update description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true - in: path name: proposal_id schema: type: integer required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDrawVoteUpdate' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DrawVoteUpdate' description: '' /games/{game_id}/draw-proposals/create/: post: operationId: games_draw_proposals_create_create description: |- Used by views that have a game parameter in the URL. Provides a get_game method that returns the game object. Also adds game to the serializer context. parameters: - in: path name: game_id schema: type: string required: true tags: - games requestBody: content: application/json: schema: $ref: '#/components/schemas/DrawProposal' security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DrawProposal' description: '' /games/fastest/: get: operationId: games_fastest_retrieve description: Return the joinable game closest to starting whose movement phases last 24 hours or longer. tags: - games security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GameFastest' description: '' /games/find-similar/: get: operationId: games_find_similar_retrieve parameters: - in: query name: movement_phase_duration schema: type: string required: true - in: query name: variant schema: type: string required: true tags: - games security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GameFindSimilar' description: '' /games/mine/current/: get: operationId: games_mine_current_retrieve description: Return the authenticated user's current games, grouped into ordered sections, each game with a single state. tags: - games security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MyGamesCurrent' description: '' /games/mine/finished/: get: operationId: games_mine_finished_list description: Return the authenticated user's finished and departed games, newest first by when each game ended for them. parameters: - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer tags: - games security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedMyGameList' description: '' /leaderboard/: get: operationId: leaderboard_list parameters: - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer tags: - leaderboard security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedLeaderboardEntryList' description: '' /moderation/reports/: get: operationId: moderation_reports_list parameters: - in: query name: status schema: type: string enum: - approved - pending - rejected description: |- * `pending` - Pending * `approved` - Approved * `rejected` - Rejected required: true tags: - moderation security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModerationReportOutput' description: '' /moderation/reports/{id}/: get: operationId: moderation_reports_retrieve parameters: - in: path name: id schema: type: integer required: true tags: - moderation security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModerationReportOutput' description: '' /moderation/reports/{id}/approve/: post: operationId: moderation_reports_approve_create parameters: - in: path name: id schema: type: integer required: true tags: - moderation requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportApproveInput' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModerationReportOutput' description: '' /moderation/reports/{id}/assign/: post: operationId: moderation_reports_assign_create parameters: - in: path name: id schema: type: integer required: true tags: - moderation security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModerationReportOutput' description: '' /moderation/reports/{id}/reject/: post: operationId: moderation_reports_reject_create parameters: - in: path name: id schema: type: integer required: true tags: - moderation requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportDecisionInput' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModerationReportOutput' description: '' /moderation/reports/{id}/reopen/: post: operationId: moderation_reports_reopen_create parameters: - in: path name: id schema: type: integer required: true tags: - moderation security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModerationReportOutput' description: '' /moderation/reports/{id}/unassign/: post: operationId: moderation_reports_unassign_create parameters: - in: path name: id schema: type: integer required: true tags: - moderation security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModerationReportOutput' description: '' /report/reasons/: get: operationId: report_reasons_list tags: - report security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportReason' description: '' /sandbox-game/: post: operationId: sandbox_game_create tags: - sandbox-game requestBody: content: application/json: schema: $ref: '#/components/schemas/GameCreateSandbox' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GameCreateSandbox' description: '' /update/check/: post: operationId: update_check_create description: |- Serves the self-hosted update protocol of @capgo/capacitor-updater. Returns the newest active bundle the caller's native binary can run, or a body with no url key when there is nothing to install. tags: - update requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCheck' required: true security: - jwtAuth: [] - {} responses: '201': content: application/json: schema: $ref: '#/components/schemas/UpdateCheckResponse' description: '' /user/: get: operationId: user_retrieve tags: - user security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserProfile' description: '' /user/delete/: delete: operationId: user_delete_destroy tags: - user security: - jwtAuth: [] responses: '204': description: No response body /user/picture/: put: operationId: user_picture_update description: Upload or remove the signed-in user's profile picture. tags: - user requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/UserProfilePicture' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserProfile' description: '' delete: operationId: user_picture_destroy description: Upload or remove the signed-in user's profile picture. tags: - user security: - jwtAuth: [] responses: '204': description: No response body /user/update/: put: operationId: user_update_update tags: - user requestBody: content: application/json: schema: $ref: '#/components/schemas/UserProfile' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserProfile' description: '' patch: operationId: user_update_partial_update tags: - user requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserProfile' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserProfile' description: '' /users/{user_id}/: get: operationId: users_retrieve parameters: - in: path name: user_id schema: type: integer required: true tags: - users security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicUserProfile' description: '' /variants/: get: operationId: variants_list tags: - variants security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Variant' description: '' post: operationId: variants_create tags: - variants requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/VariantWrite' required: true security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VariantWrite' description: '' /variants/{id}/: get: operationId: variants_retrieve parameters: - in: path name: id schema: type: string required: true tags: - variants security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Variant' description: '' put: operationId: variants_update parameters: - in: path name: id schema: type: string required: true tags: - variants requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/VariantWrite' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VariantWrite' description: '' patch: operationId: variants_partial_update parameters: - in: path name: id schema: type: string required: true tags: - variants requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PatchedVariantWrite' security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VariantWrite' description: '' delete: operationId: variants_destroy parameters: - in: path name: id schema: type: string required: true tags: - variants security: - jwtAuth: [] responses: '204': description: No response body /variants/{variant_id}/dvar/: get: operationId: variants_dvar_retrieve parameters: - in: path name: variant_id schema: type: string required: true tags: - variants security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Variant' description: '' /variants/{variant_id}/nations/{nation_id}/flag/: put: operationId: variants_nations_flag_update parameters: - in: path name: nation_id schema: type: string required: true - in: path name: variant_id schema: type: string required: true tags: - variants requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/NationFlagUpload' required: true security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Nation' description: '' delete: operationId: variants_nations_flag_destroy parameters: - in: path name: nation_id schema: type: string required: true - in: path name: variant_id schema: type: string required: true tags: - variants security: - jwtAuth: [] responses: '204': description: No response body /variants/mine/: get: operationId: variants_mine_list tags: - variants security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Variant' description: '' /version/: get: operationId: version_retrieve tags: - version security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Version' description: '' components: schemas: AddableUser: type: object properties: user_id: type: integer readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true required: - name - picture - user_id AppleAuth: type: object properties: id_token: type: string writeOnly: true first_name: type: string writeOnly: true last_name: type: string writeOnly: true id: type: integer readOnly: true email: type: string readOnly: true name: type: string readOnly: true access_token: type: string readOnly: true refresh_token: type: string readOnly: true required: - access_token - email - id - id_token - name - refresh_token BlockedReasonEnum: enum: - commitment_too_low - no_missed_orders type: string description: |- * `commitment_too_low` - Commitment too low * `no_missed_orders` - No missed orders BlogPostList: type: object properties: slug: type: string readOnly: true title: type: string readOnly: true summary: type: string readOnly: true created_at: type: string format: date-time readOnly: true required: - created_at - slug - summary - title BlogPostRetrieve: type: object properties: slug: type: string readOnly: true title: type: string readOnly: true summary: type: string readOnly: true body: type: string readOnly: true created_at: type: string format: date-time readOnly: true required: - body - created_at - slug - summary - title BotKindEnum: enum: - basic - ai type: string description: |- * `basic` - Basic * `ai` - AI Channel: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true title: type: string maxLength: 50 private: type: boolean readOnly: true messages: type: array items: $ref: '#/components/schemas/ChannelMessage' readOnly: true events: type: array items: $ref: '#/components/schemas/ChannelEvent' readOnly: true unread_message_count: type: integer readOnly: true default: 0 muted: type: boolean readOnly: true default: false can_rename: type: boolean readOnly: true can_mute: type: boolean readOnly: true can_leave: type: boolean readOnly: true member_ids: type: array items: type: integer writeOnly: true required: - can_leave - can_mute - can_rename - events - id - member_ids - messages - muted - name - private - unread_message_count ChannelDetail: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true title: type: string readOnly: true private: type: boolean readOnly: true muted: type: boolean readOnly: true can_mute: type: boolean readOnly: true can_rename: type: boolean readOnly: true can_leave: type: boolean readOnly: true unread_message_count: type: integer readOnly: true first_unread_message_id: type: integer readOnly: true nullable: true latest_message_id: type: integer readOnly: true nullable: true latest_event_id: type: integer readOnly: true nullable: true events: type: array items: $ref: '#/components/schemas/ChannelEvent' readOnly: true required: - can_leave - can_mute - can_rename - events - first_unread_message_id - id - latest_event_id - latest_message_id - muted - name - private - title - unread_message_count ChannelEvent: type: object properties: id: type: integer readOnly: true text: type: string readOnly: true created_at: type: string format: date-time readOnly: true required: - created_at - id - text ChannelMember: type: object properties: id: type: integer readOnly: true user_id: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true is_current_user: type: boolean readOnly: true is_bot: type: boolean readOnly: true bot_kind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' nation: allOf: - $ref: '#/components/schemas/Nation' nullable: true is_game_master: type: boolean readOnly: true required: - bot_kind - id - is_bot - is_current_user - is_game_master - name - nation - picture - user_id ChannelMessage: type: object properties: id: type: integer readOnly: true body: type: string maxLength: 500 client_message_id: type: string format: uuid nullable: true sender: allOf: - $ref: '#/components/schemas/ChannelMember' readOnly: true created_at: type: string format: date-time readOnly: true required: - body - created_at - id - sender ChannelMessagePage: type: object properties: results: type: array items: $ref: '#/components/schemas/ChannelMessage' readOnly: true has_older: type: boolean readOnly: true has_newer: type: boolean readOnly: true required: - has_newer - has_older - results ChannelMute: type: object properties: muted: type: boolean readOnly: true mute_duration: writeOnly: true nullable: true oneOf: - $ref: '#/components/schemas/MuteDurationEnum' - $ref: '#/components/schemas/NullEnum' required: - mute_duration - muted ChannelPreview: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true title: type: string readOnly: true private: type: boolean readOnly: true muted: type: boolean readOnly: true unread_message_count: type: integer readOnly: true latest_message: allOf: - $ref: '#/components/schemas/ChannelMessage' readOnly: true nullable: true required: - id - latest_message - muted - name - private - title - unread_message_count ChannelUpdate: type: object properties: id: type: integer readOnly: true title: type: string maxLength: 50 required: - id - title CommitmentBandEnum: enum: - dark_red - red - neutral - light_green - green - dark_green type: string description: |- * `dark_red` - Dark red * `red` - Red * `neutral` - Neutral * `light_green` - Light green * `green` - Green * `dark_green` - Dark green CommitmentBreakdown: type: object properties: kind: allOf: - $ref: '#/components/schemas/CommitmentEventKindEnum' readOnly: true count: type: integer readOnly: true points: type: integer readOnly: true required: - count - kind - points CommitmentEventKindEnum: enum: - submitted - nmr - civil_disorder - early_withdrawal - late_withdrawal - muster_no_show type: string description: |- * `submitted` - Submitted * `nmr` - NMR * `civil_disorder` - Civil disorder * `early_withdrawal` - Early withdrawal * `late_withdrawal` - Late withdrawal * `muster_no_show` - Muster no-show CommitmentRequirementEnum: enum: - open - committed type: string description: |- * `open` - Open * `committed` - Committed CommitmentSquare: type: object properties: anonymous: type: boolean readOnly: true game_name: type: string nullable: true readOnly: true submitted: type: integer readOnly: true missed: type: integer readOnly: true breakdown: type: array items: $ref: '#/components/schemas/CommitmentBreakdown' readOnly: true points: type: integer readOnly: true shade: allOf: - $ref: '#/components/schemas/ShadeEnum' readOnly: true required: - anonymous - breakdown - game_name - missed - points - shade - submitted DeadlineModeEnum: enum: - duration - fixed_time type: string description: |- * `duration` - Duration * `fixed_time` - Fixed Time DepartureEnum: enum: - eliminated - civil_disorder - withdrawn - removed type: string description: |- * `eliminated` - Eliminated * `civil_disorder` - Civil disorder * `withdrawn` - Withdrawn * `removed` - Removed DrawProposal: type: object properties: id: type: integer readOnly: true created_by: allOf: - $ref: '#/components/schemas/DrawVoteMember' readOnly: true status: type: string readOnly: true accepted_count: type: integer readOnly: true rejected_count: type: integer readOnly: true pending_count: type: integer readOnly: true total_votes: type: integer readOnly: true included_member_ids: type: array items: type: integer readOnly: true my_vote: allOf: - $ref: '#/components/schemas/MyVote' nullable: true readOnly: true phase_id: type: integer readOnly: true phase_name: type: string readOnly: true created_at: type: string format: date-time readOnly: true required: - accepted_count - created_at - created_by - id - included_member_ids - my_vote - pending_count - phase_id - phase_name - rejected_count - status - total_votes DrawVoteMember: type: object properties: id: type: integer readOnly: true user_id: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true is_current_user: type: boolean readOnly: true is_bot: type: boolean readOnly: true bot_kind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' nation: type: string nullable: true required: - bot_kind - id - is_bot - is_current_user - name - nation - picture - user_id DrawVoteUpdate: type: object properties: accepted: type: boolean required: - accepted DurationEnum: enum: - 5 minutes - 15 minutes - 30 minutes - 1 hour - 2 hours - 4 hours - 8 hours - 12 hours - 24 hours - 48 hours - 3 days - 4 days - 1 week - 2 weeks type: string description: |- * `5 minutes` - 5 minutes * `15 minutes` - 15 minutes * `30 minutes` - 30 minutes * `1 hour` - 1 hour * `2 hours` - 2 hours * `4 hours` - 4 hours * `8 hours` - 8 hours * `12 hours` - 12 hours * `24 hours` - 24 hours * `48 hours` - 48 hours * `3 days` - 3 days * `4 days` - 4 days * `1 week` - 1 week * `2 weeks` - 2 weeks EmailLogin: type: object properties: email: type: string format: email password: type: string writeOnly: true id: type: integer readOnly: true name: type: string readOnly: true access_token: type: string readOnly: true refresh_token: type: string readOnly: true required: - access_token - email - id - name - password - refresh_token FCMDevice: type: object properties: id: type: integer readOnly: true name: type: string nullable: true maxLength: 255 registration_id: type: string title: Registration token device_id: type: string nullable: true description: Unique device identifier maxLength: 255 active: type: boolean default: true title: Is active description: Inactive devices will not be sent notifications date_created: type: string format: date-time readOnly: true nullable: true title: Creation date type: $ref: '#/components/schemas/TypeEnum' required: - date_created - id - registration_id - type FieldValue: type: object properties: id: type: string label: type: string required: - id - label FlatOrderOption: type: object properties: source: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true order_type: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true target: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true aux: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true unit_type: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true named_coast: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true required: - aux - named_coast - order_type - source - target - unit_type GameAction: type: object properties: key: allOf: - $ref: '#/components/schemas/GameActionKeyEnum' readOnly: true blocked_reason: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' required: - blocked_reason - key GameActionKeyEnum: enum: - join - confirm_seat - edit_nation_preferences - assign_nations - extend_deadline - pause - unpause - clone_to_sandbox - leave - withdraw - delete type: string description: |- * `join` - Join * `confirm_seat` - Confirm seat * `edit_nation_preferences` - Edit nation preferences * `assign_nations` - Assign nations * `extend_deadline` - Extend deadline * `pause` - Pause * `unpause` - Unpause * `clone_to_sandbox` - Clone to sandbox * `leave` - Leave * `withdraw` - Withdraw * `delete` - Delete GameCloneToSandbox: type: object properties: id: type: string readOnly: true required: - id GameCreate: type: object properties: id: type: string readOnly: true name: type: string variant_id: type: string movement_phase_duration: allOf: - $ref: '#/components/schemas/DurationEnum' default: 24 hours retreat_phase_duration: nullable: true oneOf: - $ref: '#/components/schemas/DurationEnum' - $ref: '#/components/schemas/NullEnum' private: type: boolean anonymous: type: boolean default: false ranked: type: boolean default: false game_master: type: boolean default: false deadline_mode: allOf: - $ref: '#/components/schemas/DeadlineModeEnum' default: fixed_time fixed_deadline_time: type: string format: time nullable: true fixed_deadline_timezone: type: string nullable: true maxLength: 50 movement_frequency: nullable: true oneOf: - $ref: '#/components/schemas/MovementFrequencyEnum' - $ref: '#/components/schemas/NullEnum' retreat_frequency: nullable: true oneOf: - $ref: '#/components/schemas/RetreatFrequencyEnum' - $ref: '#/components/schemas/NullEnum' nmr_extensions_allowed: type: integer maximum: 2 minimum: 0 default: 0 press_type: allOf: - $ref: '#/components/schemas/PressTypeEnum' default: full_press commitment_requirement: allOf: - $ref: '#/components/schemas/CommitmentRequirementEnum' default: open required: - id - name - private - variant_id GameCreateSandbox: type: object properties: id: type: string readOnly: true name: type: string variant_id: type: string required: - id - name - variant_id GameExtendDeadline: type: object properties: duration: $ref: '#/components/schemas/DurationEnum' required: - duration GameFastest: type: object properties: game: allOf: - $ref: '#/components/schemas/GameList' nullable: true required: - game GameFindSimilar: type: object properties: game: allOf: - $ref: '#/components/schemas/GameList' nullable: true required: - game GameList: type: object properties: id: type: string readOnly: true name: type: string readOnly: true status: type: string readOnly: true created_at: type: string format: date-time readOnly: true can_join: type: boolean readOnly: true can_leave: type: boolean readOnly: true can_withdraw: type: boolean readOnly: true can_delete: type: boolean readOnly: true can_manage: type: boolean readOnly: true game_master: allOf: - $ref: '#/components/schemas/GameMaster' readOnly: true nullable: true variant_id: type: string readOnly: true phases: type: array items: type: integer readOnly: true current_phase_id: type: integer nullable: true readOnly: true current_phase: allOf: - $ref: '#/components/schemas/GameListCurrentPhase' nullable: true readOnly: true phase_confirmed: type: boolean readOnly: true order_status: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/OrderStatusEnum' - $ref: '#/components/schemas/NullEnum' member_status: type: array items: $ref: '#/components/schemas/MemberStatusEnum' nullable: true readOnly: true private: type: boolean readOnly: true anonymous: type: boolean readOnly: true ranked: type: boolean readOnly: true movement_phase_duration: type: string readOnly: true nullable: true retreat_phase_duration: type: string readOnly: true nullable: true show_short_game_join_warning: type: boolean readOnly: true members: type: array items: $ref: '#/components/schemas/Member' readOnly: true victory: allOf: - $ref: '#/components/schemas/Victory' readOnly: true nullable: true sandbox: type: boolean readOnly: true is_paused: type: boolean readOnly: true paused_at: type: string format: date-time readOnly: true nullable: true nmr_extensions_allowed: type: integer readOnly: true deadline_mode: type: string readOnly: true fixed_deadline_time: type: string format: time readOnly: true nullable: true fixed_deadline_timezone: type: string readOnly: true nullable: true movement_frequency: type: string readOnly: true nullable: true retreat_frequency: type: string readOnly: true nullable: true press_type: type: string readOnly: true commitment_requirement: type: string readOnly: true join_blocked_reason: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' muster_required: type: boolean readOnly: true muster_deadline: type: string format: date-time readOnly: true nullable: true muster_status: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/MusterStatusEnum' - $ref: '#/components/schemas/NullEnum' total_unread_message_count: type: integer readOnly: true default: 0 required: - anonymous - can_delete - can_join - can_leave - can_manage - can_withdraw - commitment_requirement - created_at - current_phase - current_phase_id - deadline_mode - fixed_deadline_time - fixed_deadline_timezone - game_master - id - is_paused - join_blocked_reason - member_status - members - movement_frequency - movement_phase_duration - muster_deadline - muster_required - muster_status - name - nmr_extensions_allowed - order_status - paused_at - phase_confirmed - phases - press_type - private - ranked - retreat_frequency - retreat_phase_duration - sandbox - show_short_game_join_warning - status - total_unread_message_count - variant_id - victory GameListBoardNation: type: object properties: name: type: string readOnly: true required: - name GameListBoardProvince: type: object properties: id: type: string readOnly: true required: - id GameListCurrentPhase: type: object properties: id: type: integer readOnly: true ordinal: type: integer readOnly: true season: type: string readOnly: true year: type: integer readOnly: true name: type: string readOnly: true type: type: string readOnly: true status: type: string readOnly: true scheduled_resolution: type: string format: date-time readOnly: true nullable: true remaining_time: type: integer readOnly: true units: type: array items: $ref: '#/components/schemas/GameListUnit' readOnly: true supply_centers: type: array items: $ref: '#/components/schemas/GameListSupplyCenter' readOnly: true required: - id - name - ordinal - remaining_time - scheduled_resolution - season - status - supply_centers - type - units - year GameListSupplyCenter: type: object properties: nation: allOf: - $ref: '#/components/schemas/GameListBoardNation' readOnly: true province: allOf: - $ref: '#/components/schemas/GameListBoardProvince' readOnly: true required: - nation - province GameListUnit: type: object properties: type: type: string readOnly: true nation: allOf: - $ref: '#/components/schemas/GameListBoardNation' readOnly: true province: allOf: - $ref: '#/components/schemas/GameListBoardProvince' readOnly: true dislodged: type: boolean readOnly: true required: - dislodged - nation - province - type GameMaster: type: object properties: user_id: type: integer readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true required: - name - picture - user_id GameRetrieve: type: object properties: id: type: string readOnly: true name: type: string readOnly: true status: type: string readOnly: true created_at: type: string format: date-time readOnly: true can_join: type: boolean readOnly: true can_leave: type: boolean readOnly: true can_withdraw: type: boolean readOnly: true is_first_year: type: boolean readOnly: true can_delete: type: boolean readOnly: true can_manage: type: boolean readOnly: true can_create_channel: type: boolean readOnly: true game_master: allOf: - $ref: '#/components/schemas/GameMaster' readOnly: true nullable: true game_master_member_id: type: integer nullable: true readOnly: true phases: type: array items: type: integer readOnly: true current_phase_id: type: integer nullable: true readOnly: true members: type: array items: $ref: '#/components/schemas/Member' readOnly: true sandbox: type: boolean readOnly: true victory: allOf: - $ref: '#/components/schemas/Victory' readOnly: true nullable: true variant_id: type: string readOnly: true phase_confirmed: type: boolean readOnly: true order_status: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/OrderStatusEnum' - $ref: '#/components/schemas/NullEnum' member_status: type: array items: $ref: '#/components/schemas/MemberStatusEnum' nullable: true readOnly: true movement_phase_duration: type: string readOnly: true nullable: true retreat_phase_duration: type: string readOnly: true nullable: true show_short_game_join_warning: type: boolean readOnly: true private: type: boolean readOnly: true anonymous: type: boolean readOnly: true ranked: type: boolean readOnly: true is_paused: type: boolean readOnly: true paused_at: type: string format: date-time readOnly: true nullable: true nmr_extensions_allowed: type: integer readOnly: true deadline_mode: type: string readOnly: true fixed_deadline_time: type: string format: time readOnly: true nullable: true fixed_deadline_timezone: type: string readOnly: true nullable: true movement_frequency: type: string readOnly: true nullable: true retreat_frequency: type: string readOnly: true nullable: true press_type: type: string readOnly: true commitment_requirement: type: string readOnly: true join_blocked_reason: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' muster_required: type: boolean readOnly: true muster_deadline: type: string format: date-time readOnly: true nullable: true muster_status: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/MusterStatusEnum' - $ref: '#/components/schemas/NullEnum' total_unread_message_count: type: integer readOnly: true actions: type: array items: $ref: '#/components/schemas/GameAction' readOnly: true player_list_actions: type: array items: $ref: '#/components/schemas/GameAction' readOnly: true required: - actions - anonymous - can_create_channel - can_delete - can_join - can_leave - can_manage - can_withdraw - commitment_requirement - created_at - current_phase_id - deadline_mode - fixed_deadline_time - fixed_deadline_timezone - game_master - game_master_member_id - id - is_first_year - is_paused - join_blocked_reason - member_status - members - movement_frequency - movement_phase_duration - muster_deadline - muster_required - muster_status - name - nmr_extensions_allowed - order_status - paused_at - phase_confirmed - phases - player_list_actions - press_type - private - ranked - retreat_frequency - retreat_phase_duration - sandbox - show_short_game_join_warning - status - total_unread_message_count - variant_id - victory GoogleAuth: type: object properties: id_token: type: string writeOnly: true id: type: integer readOnly: true email: type: string readOnly: true name: type: string readOnly: true access_token: type: string readOnly: true refresh_token: type: string readOnly: true required: - access_token - email - id - id_token - name - refresh_token KindEnum: enum: - confirm_seat - submit_orders - vote_on_draw - seat_confirmed - orders_unconfirmed - orders_confirmed - resolving - mustering - waiting_for_players - paused - sandbox - finished type: string description: |- * `confirm_seat` - Confirm seat * `submit_orders` - Submit orders * `vote_on_draw` - Vote on draw * `seat_confirmed` - Seat confirmed * `orders_unconfirmed` - Orders unconfirmed * `orders_confirmed` - Orders confirmed * `resolving` - Resolving * `mustering` - Mustering * `waiting_for_players` - Waiting for players * `paused` - Paused * `sandbox` - Sandbox * `finished` - Finished LeaderboardEntry: type: object properties: rank: type: integer readOnly: true user_id: type: integer readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true rating: type: number format: double readOnly: true required: - name - picture - rank - rating - user_id Mark: type: object properties: reason: allOf: - $ref: '#/components/schemas/ReasonEnum' readOnly: true created_at: type: string format: date-time readOnly: true required: - created_at - reason Member: type: object properties: id: type: integer readOnly: true user_id: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true is_current_user: type: boolean readOnly: true is_bot: type: boolean readOnly: true bot_kind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' nation: type: string readOnly: true nullable: true eliminated: type: boolean readOnly: true kicked: type: boolean readOnly: true is_game_creator: type: boolean readOnly: true is_admin: type: boolean readOnly: true nmr_extensions_remaining: type: integer readOnly: true civil_disorder: type: boolean readOnly: true withdrawn: type: boolean readOnly: true seeking_replacement: type: boolean readOnly: true replaceable: type: boolean readOnly: true seat_confirmed: type: boolean readOnly: true nullable: true removable: type: boolean readOnly: true nation_preference_ids: type: array items: type: string readOnly: true commitment_total: type: integer nullable: true readOnly: true commitment_band: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/CommitmentBandEnum' - $ref: '#/components/schemas/NullEnum' rating_change: type: integer nullable: true readOnly: true rating_before: type: integer nullable: true readOnly: true rating_after: type: integer nullable: true readOnly: true required: - bot_kind - civil_disorder - commitment_band - commitment_total - eliminated - id - is_admin - is_bot - is_current_user - is_game_creator - kicked - name - nation - nation_preference_ids - nmr_extensions_remaining - picture - rating_after - rating_before - rating_change - removable - replaceable - seat_confirmed - seeking_replacement - user_id - withdrawn MemberAction: type: object properties: key: allOf: - $ref: '#/components/schemas/MemberActionKeyEnum' readOnly: true blocked_reason: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' required: - blocked_reason - key MemberActionKeyEnum: enum: - join - confirm_seat - edit_nation_preferences - assign_nations - extend_deadline - pause - unpause - clone_to_sandbox - leave - withdraw - delete - take_over - share_replacement_link - remove_from_lobby - remove_from_game type: string description: |- * `join` - Join * `confirm_seat` - Confirm seat * `edit_nation_preferences` - Edit nation preferences * `assign_nations` - Assign nations * `extend_deadline` - Extend deadline * `pause` - Pause * `unpause` - Unpause * `clone_to_sandbox` - Clone to sandbox * `leave` - Leave * `withdraw` - Withdraw * `delete` - Delete * `take_over` - Take over * `share_replacement_link` - Share replacement link * `remove_from_lobby` - Remove from lobby * `remove_from_game` - Remove from game MemberCreate: type: object properties: user_id: type: integer writeOnly: true required: - user_id MemberDetail: type: object properties: id: type: integer readOnly: true user_id: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true is_current_user: type: boolean readOnly: true is_bot: type: boolean readOnly: true bot_kind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' is_admin: type: boolean readOnly: true nation: type: string readOnly: true nullable: true participation_status: allOf: - $ref: '#/components/schemas/ParticipationStatusEnum' readOnly: true supply_center_count: type: integer nullable: true readOnly: true unit_count: type: integer nullable: true readOnly: true nmr_extensions_remaining: type: integer readOnly: true nmr_extensions_allowed: type: integer readOnly: true nation_preferences: type: array items: type: string nullable: true readOnly: true actions: type: array items: $ref: '#/components/schemas/MemberAction' readOnly: true can_report: type: boolean readOnly: true already_reported: type: boolean readOnly: true rated: type: boolean readOnly: true required: - actions - already_reported - bot_kind - can_report - id - is_admin - is_bot - is_current_user - name - nation - nation_preferences - nmr_extensions_allowed - nmr_extensions_remaining - participation_status - picture - rated - supply_center_count - unit_count - user_id MemberNationAssign: type: object properties: nation_id: type: string writeOnly: true required: - nation_id MemberNationPreference: type: object properties: nation_ids: type: array items: type: string required: - nation_ids MemberStatusEnum: enum: - nmr - civil_disorder type: string description: |- * `nmr` - nmr * `civil_disorder` - civil_disorder MemberWithdraw: type: object properties: reason: allOf: - $ref: '#/components/schemas/WithdrawalReasonEnum' writeOnly: true ModerationMemberOutput: type: object properties: id: type: integer readOnly: true user_id: type: integer nullable: true readOnly: true name: type: string readOnly: true nullable: true nation: type: string readOnly: true nullable: true required: - id - name - nation - user_id ModerationReportAction: type: object properties: key: $ref: '#/components/schemas/ModerationReportActionKeyEnum' blocked_reason: nullable: true oneOf: - $ref: '#/components/schemas/ModerationReportActionBlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' required: - blocked_reason - key ModerationReportActionBlockedReasonEnum: enum: - already_assigned - already_reviewed - game_member - not_assignee - not_moderator - not_reviewed type: string description: |- * `already_assigned` - already_assigned * `already_reviewed` - already_reviewed * `game_member` - game_member * `not_assignee` - not_assignee * `not_moderator` - not_moderator * `not_reviewed` - not_reviewed ModerationReportActionKeyEnum: enum: - assign - unassign - approve - reject - reopen type: string description: |- * `assign` - assign * `unassign` - unassign * `approve` - approve * `reject` - reject * `reopen` - reopen ModerationReportOutput: type: object properties: id: type: integer readOnly: true reason: allOf: - $ref: '#/components/schemas/ReasonEnum' readOnly: true note: type: string readOnly: true maxLength: 1000 status: allOf: - $ref: '#/components/schemas/ReportStatusEnum' readOnly: true created_at: type: string format: date-time readOnly: true game_id: type: string readOnly: true game_name: type: string readOnly: true variant_name: type: string readOnly: true reporter: allOf: - $ref: '#/components/schemas/ModerationMemberOutput' readOnly: true reported: allOf: - $ref: '#/components/schemas/ModerationMemberOutput' readOnly: true review: allOf: - $ref: '#/components/schemas/ModerationReviewOutput' readOnly: true nullable: true assigned_to: allOf: - $ref: '#/components/schemas/ModerationReviewerOutput' readOnly: true nullable: true actions: type: array items: $ref: '#/components/schemas/ModerationReportAction' readOnly: true can_view_game: type: boolean readOnly: true required: - actions - assigned_to - can_view_game - created_at - game_id - game_name - id - note - reason - reported - reporter - review - status - variant_name ModerationReviewOutput: type: object properties: reviewed_by: allOf: - $ref: '#/components/schemas/ModerationReviewerOutput' readOnly: true note: type: string readOnly: true maxLength: 1000 created_at: type: string format: date-time readOnly: true required: - created_at - note - reviewed_by ModerationReviewerOutput: type: object properties: user_id: type: integer readOnly: true name: type: string readOnly: true required: - name - user_id MovementFrequencyEnum: enum: - hourly - daily - every_2_days - weekly type: string description: |- * `hourly` - Hourly * `daily` - Daily * `every_2_days` - Every 2 days * `weekly` - Weekly MusterStatusEnum: enum: - confirmation_required - confirmed type: string description: |- * `confirmation_required` - confirmation_required * `confirmed` - confirmed MuteDurationEnum: enum: - 8_hours - 24_hours - indefinite type: string description: |- * `8_hours` - 8_hours * `24_hours` - 24_hours * `indefinite` - indefinite MyGame: type: object properties: id: type: string readOnly: true name: type: string readOnly: true status: type: string readOnly: true variant_id: type: string readOnly: true sandbox: type: boolean readOnly: true current_phase_id: type: integer readOnly: true nullable: true current_phase: allOf: - $ref: '#/components/schemas/GameListCurrentPhase' readOnly: true nullable: true nation: type: string readOnly: true nullable: true seats: allOf: - $ref: '#/components/schemas/MyGameSeats' readOnly: true nullable: true unread_count: type: integer readOnly: true state: allOf: - $ref: '#/components/schemas/MyGameState' readOnly: true required: - current_phase - current_phase_id - id - name - nation - sandbox - seats - state - status - unread_count - variant_id MyGameSeats: type: object properties: filled: type: integer readOnly: true total: type: integer readOnly: true required: - filled - total MyGameState: type: object properties: kind: allOf: - $ref: '#/components/schemas/KindEnum' readOnly: true deadline: type: string format: date-time readOnly: true nullable: true result: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/ResultEnum' - $ref: '#/components/schemas/NullEnum' winner: type: string readOnly: true nullable: true departure: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/DepartureEnum' - $ref: '#/components/schemas/NullEnum' required: - deadline - departure - kind - result - winner MyGamesCurrent: type: object properties: sections: type: array items: $ref: '#/components/schemas/MyGamesSection' readOnly: true required: - sections MyGamesSection: type: object properties: key: allOf: - $ref: '#/components/schemas/MyGamesSectionKeyEnum' readOnly: true games: type: array items: $ref: '#/components/schemas/MyGame' readOnly: true required: - games - key MyGamesSectionKeyEnum: enum: - needs_attention - managing - active - mustering - pending - recently_finished - sandbox type: string description: |- * `needs_attention` - Needs attention * `managing` - Managing * `active` - Active * `mustering` - Mustering * `pending` - Pending * `recently_finished` - Recently finished * `sandbox` - Sandbox MyVote: type: object properties: included: type: boolean readOnly: true accepted: type: boolean readOnly: true nullable: true required: - accepted - included Nation: type: object properties: nation_id: type: string name: type: string color: type: string readOnly: true non_playable: type: boolean flag_url: type: string format: uri nullable: true readOnly: true required: - color - flag_url - name - nation_id - non_playable NationFlagUpload: type: object properties: flag: type: string format: uri writeOnly: true required: - flag NullEnum: enum: - null Order: type: object properties: source: allOf: - $ref: '#/components/schemas/Province' readOnly: true source_coast: allOf: - $ref: '#/components/schemas/Province' readOnly: true nullable: true target: allOf: - $ref: '#/components/schemas/Province' readOnly: true target_coast: allOf: - $ref: '#/components/schemas/Province' readOnly: true nullable: true aux: allOf: - $ref: '#/components/schemas/Province' readOnly: true named_coast: allOf: - $ref: '#/components/schemas/Province' readOnly: true resolution: allOf: - $ref: '#/components/schemas/OrderResolution' readOnly: true order_type: allOf: - $ref: '#/components/schemas/OrderTypeEnum' readOnly: true unit_type: allOf: - $ref: '#/components/schemas/UnitTypeEnum' readOnly: true nation: allOf: - $ref: '#/components/schemas/Nation' readOnly: true is_implicit: type: boolean readOnly: true complete: type: boolean readOnly: true nullable: true step: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/StepEnum' - $ref: '#/components/schemas/NullEnum' title: type: string readOnly: true nullable: true summary: type: string readOnly: true nullable: true selected: type: array items: type: string required: - aux - complete - is_implicit - named_coast - nation - order_type - resolution - source - source_coast - step - summary - target - target_coast - title - unit_type OrderOptionsResponse: type: object properties: orders: type: array items: $ref: '#/components/schemas/FlatOrderOption' field_order: type: object additionalProperties: type: array items: type: string required: - field_order - orders OrderResolution: type: object properties: status: type: string by: allOf: - $ref: '#/components/schemas/Province' nullable: true required: - by - status OrderStatusEnum: enum: - orders_required - orders_submitted - orders_not_confirmed - no_orders_required type: string description: |- * `orders_required` - orders_required * `orders_submitted` - orders_submitted * `orders_not_confirmed` - orders_not_confirmed * `no_orders_required` - no_orders_required OrderTypeEnum: enum: - Move - MoveViaConvoy - Hold - Support - Convoy - Build - Disband type: string description: |- * `Move` - Move * `MoveViaConvoy` - Move via Convoy * `Hold` - Hold * `Support` - Support * `Convoy` - Convoy * `Build` - Build * `Disband` - Disband PaginatedGameListList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/GameList' PaginatedLeaderboardEntryList: type: object required: - count - results - own properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/LeaderboardEntry' own: allOf: - $ref: '#/components/schemas/LeaderboardEntry' nullable: true PaginatedMyGameList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/MyGame' ParticipationStatusEnum: enum: - game_master - replaced - removed - withdrawn - won - drew - eliminated - civil_disorder - seat_unconfirmed - seat_confirmed - joined - playing type: string description: |- * `game_master` - Game master * `replaced` - Replaced * `removed` - Removed * `withdrawn` - Withdrawn * `won` - Won * `drew` - Drew * `eliminated` - Eliminated * `civil_disorder` - Civil disorder * `seat_unconfirmed` - Seat unconfirmed * `seat_confirmed` - Seat confirmed * `joined` - Joined * `playing` - Playing PasswordReset: type: object properties: email: type: string format: email writeOnly: true required: - email PasswordResetConfirm: type: object properties: uid: type: string writeOnly: true token: type: string writeOnly: true new_password: type: string writeOnly: true minLength: 8 confirm_password: type: string writeOnly: true minLength: 8 required: - confirm_password - new_password - token - uid PatchedChannelMute: type: object properties: muted: type: boolean readOnly: true mute_duration: writeOnly: true nullable: true oneOf: - $ref: '#/components/schemas/MuteDurationEnum' - $ref: '#/components/schemas/NullEnum' PatchedChannelUpdate: type: object properties: id: type: integer readOnly: true title: type: string maxLength: 50 PatchedDrawVoteUpdate: type: object properties: accepted: type: boolean PatchedGameExtendDeadline: type: object properties: duration: $ref: '#/components/schemas/DurationEnum' PatchedMemberWithdraw: type: object properties: reason: allOf: - $ref: '#/components/schemas/WithdrawalReasonEnum' writeOnly: true PatchedPhaseState: type: object properties: id: type: string readOnly: true orders_confirmed: type: boolean readOnly: true eliminated: type: boolean readOnly: true orderable_provinces: type: array items: $ref: '#/components/schemas/Province' readOnly: true member: allOf: - $ref: '#/components/schemas/Member' readOnly: true max_orders: type: integer nullable: true readOnly: true PatchedUserProfile: type: object properties: id: type: integer readOnly: true user_id: type: integer readOnly: true name: type: string maxLength: 255 minLength: 2 picture: type: string nullable: true readOnly: true email: type: string readOnly: true can_create_bot_games: type: boolean readOnly: true is_moderator: type: boolean readOnly: true can_create_committed_game: type: boolean readOnly: true PatchedVariantWrite: type: object properties: dvar: type: string format: uri writeOnly: true dsvg: type: string format: uri writeOnly: true PhaseList: type: object properties: id: type: integer ordinal: type: integer season: type: string year: type: integer name: type: string type: type: string status: $ref: '#/components/schemas/StatusEnum' required: - id - name - ordinal - season - status - type - year PhaseRetrieve: type: object properties: id: type: integer ordinal: type: integer season: type: string year: type: integer name: type: string type: type: string remaining_time: type: integer scheduled_resolution: type: string format: date-time status: $ref: '#/components/schemas/StatusEnum' units: type: array items: $ref: '#/components/schemas/Unit' supply_centers: type: array items: $ref: '#/components/schemas/SupplyCenter' previous_phase_id: type: integer nullable: true next_phase_id: type: integer nullable: true province_nations: type: string readOnly: true required: - id - name - next_phase_id - ordinal - previous_phase_id - province_nations - remaining_time - scheduled_resolution - season - status - supply_centers - type - units - year PhaseState: type: object properties: id: type: string readOnly: true orders_confirmed: type: boolean readOnly: true eliminated: type: boolean readOnly: true orderable_provinces: type: array items: $ref: '#/components/schemas/Province' readOnly: true member: allOf: - $ref: '#/components/schemas/Member' readOnly: true max_orders: type: integer nullable: true readOnly: true required: - eliminated - id - max_orders - member - orderable_provinces - orders_confirmed PlatformEnum: enum: - ios - android type: string description: |- * `ios` - iOS * `android` - Android PressTypeEnum: enum: - full_press - no_press type: string description: |- * `full_press` - Full Press * `no_press` - No Press ProfileRating: type: object properties: rating: type: integer readOnly: true rank: type: integer readOnly: true nullable: true won: type: integer readOnly: true drew: type: integer readOnly: true lost: type: integer readOnly: true required: - drew - lost - rank - rating - won Province: type: object properties: id: type: string name: type: string type: type: string supply_center: type: boolean parent_id: type: string nullable: true named_coast_ids: type: array items: type: string readOnly: true required: - id - name - named_coast_ids - parent_id - supply_center - type PublicUserProfile: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true bot_kind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' created_at: type: string format: date-time nullable: true readOnly: true total_games: type: integer readOnly: true active_games: type: integer readOnly: true commitment_total: type: integer readOnly: true commitment_band: allOf: - $ref: '#/components/schemas/CommitmentBandEnum' readOnly: true commitment_squares: type: array items: $ref: '#/components/schemas/CommitmentSquare' readOnly: true rating: allOf: - $ref: '#/components/schemas/ProfileRating' nullable: true readOnly: true marks: type: array items: $ref: '#/components/schemas/Mark' readOnly: true required: - active_games - bot_kind - commitment_band - commitment_squares - commitment_total - created_at - id - marks - name - picture - rating - total_games RatingOpponent: type: object properties: id: type: integer readOnly: true user_id: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true is_current_user: type: boolean readOnly: true is_bot: type: boolean readOnly: true bot_kind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' nation: type: string nullable: true required: - bot_kind - id - is_bot - is_current_user - name - nation - picture - user_id RatingPairingOutput: type: object properties: id: type: integer readOnly: true opponent: allOf: - $ref: '#/components/schemas/RatingOpponent' readOnly: true opponent_rating: type: number format: double readOnly: true score: type: number format: double readOnly: true change: type: number format: double readOnly: true required: - change - id - opponent - opponent_rating - score RatingResultOutput: type: object properties: id: type: integer readOnly: true rating_before: type: number format: double readOnly: true rating_after: type: number format: double readOnly: true rating_change: type: number format: double readOnly: true protected: type: boolean readOnly: true pairings: type: array items: $ref: '#/components/schemas/RatingPairingOutput' readOnly: true required: - id - pairings - protected - rating_after - rating_before - rating_change ReasonEnum: enum: - abuse_and_harassment - multiple_accounts - secret_teaming - abuse_of_admin_powers - other type: string description: |- * `abuse_and_harassment` - Abuse and harassment * `multiple_accounts` - Multiple accounts * `secret_teaming` - Secret teaming * `abuse_of_admin_powers` - Abuse of admin powers * `other` - Other Register: type: object properties: email: type: string format: email writeOnly: true password: type: string writeOnly: true minLength: 8 display_name: type: string writeOnly: true required: - display_name - email - password ReportApproveInput: type: object properties: note: type: string default: '' maxLength: 1000 reason: $ref: '#/components/schemas/ReasonEnum' ReportDecisionInput: type: object properties: note: type: string default: '' maxLength: 1000 ReportMemberInput: type: object properties: reason: $ref: '#/components/schemas/ReasonEnum' note: type: string maxLength: 1000 required: - note - reason ReportOutput: type: object properties: id: type: integer readOnly: true reported: type: integer readOnly: true reason: allOf: - $ref: '#/components/schemas/ReasonEnum' readOnly: true note: type: string readOnly: true maxLength: 1000 status: type: string readOnly: true created_at: type: string format: date-time readOnly: true required: - created_at - id - note - reason - reported - status ReportReason: type: object properties: key: allOf: - $ref: '#/components/schemas/ReasonEnum' readOnly: true label: type: string readOnly: true description: type: string readOnly: true required: - description - key - label ReportStatusEnum: enum: - pending - approved - rejected type: string description: |- * `pending` - Pending * `approved` - Approved * `rejected` - Rejected ResultEnum: enum: - solo_victory - won_by - draw - abandoned - ongoing type: string description: |- * `solo_victory` - Solo victory * `won_by` - Won by * `draw` - Draw * `abandoned` - Abandoned * `ongoing` - Ongoing RetreatFrequencyEnum: enum: - hourly - daily - every_2_days - weekly type: string description: |- * `hourly` - Hourly * `daily` - Daily * `every_2_days` - Every 2 days * `weekly` - Weekly ShadeEnum: enum: - dark_red - red - light_red - grey - light_green - green - dark_green type: string description: |- * `dark_red` - Dark red * `red` - Red * `light_red` - Light red * `grey` - Grey * `light_green` - Light green * `green` - Green * `dark_green` - Dark green StatusEnum: enum: - pending - active - processing - completed - template type: string description: |- * `pending` - Pending * `active` - Active * `processing` - Processing * `completed` - Completed * `template` - Template StepEnum: enum: - select-order-type - select-unit-type - select-target - select-aux - select-named-coast - completed type: string description: |- * `select-order-type` - select-order-type * `select-unit-type` - select-unit-type * `select-target` - select-target * `select-aux` - select-aux * `select-named-coast` - select-named-coast * `completed` - completed SupplyCenter: type: object properties: province: $ref: '#/components/schemas/Province' nation: $ref: '#/components/schemas/Nation' required: - nation - province TokenRefresh: type: object properties: access: type: string readOnly: true refresh: type: string writeOnly: true required: - access - refresh TypeEnum: enum: - ios - android - web type: string description: |- * `ios` - ios * `android` - android * `web` - web Unit: type: object properties: type: type: string nation: $ref: '#/components/schemas/Nation' province: $ref: '#/components/schemas/Province' dislodged: type: boolean dislodged_from: allOf: - $ref: '#/components/schemas/Province' nullable: true required: - dislodged - dislodged_from - nation - province - type UnitTypeEnum: enum: - Army - Fleet type: string description: |- * `Army` - Army * `Fleet` - Fleet UpdateCheck: type: object properties: platform: allOf: - $ref: '#/components/schemas/PlatformEnum' writeOnly: true version_build: type: string writeOnly: true version_name: type: string writeOnly: true required: - platform - version_build - version_name UpdateCheckResponse: type: object properties: version: type: string url: type: string checksum: type: string kind: type: string message: type: string UserProfile: type: object properties: id: type: integer readOnly: true user_id: type: integer readOnly: true name: type: string maxLength: 255 minLength: 2 picture: type: string nullable: true readOnly: true email: type: string readOnly: true can_create_bot_games: type: boolean readOnly: true is_moderator: type: boolean readOnly: true can_create_committed_game: type: boolean readOnly: true required: - can_create_bot_games - can_create_committed_game - email - id - is_moderator - name - picture - user_id UserProfilePicture: type: object properties: picture: type: string format: uri writeOnly: true required: - picture Variant: type: object properties: id: type: string name: type: string description: type: string author: type: string rules: type: string unit_scaling: type: number format: double status: type: string readOnly: true official: type: boolean readOnly: true ranked: type: boolean readOnly: true owner_id: type: integer readOnly: true nullable: true owner_username: type: string nullable: true readOnly: true can_edit: type: boolean readOnly: true victory_conditions: $ref: '#/components/schemas/VictoryConditions' svg_url: type: string nullable: true readOnly: true nations: type: array items: $ref: '#/components/schemas/VariantNation' provinces: type: array items: $ref: '#/components/schemas/VariantProvince' template_phase: $ref: '#/components/schemas/VariantTemplatePhase' required: - can_edit - description - id - name - nations - official - owner_id - owner_username - provinces - ranked - rules - status - svg_url - template_phase - unit_scaling - victory_conditions VariantNation: type: object properties: nation_id: type: string name: type: string color: type: string readOnly: true non_playable: type: boolean flag_url: type: string format: uri nullable: true readOnly: true solo_victory_supply_centers: type: integer nullable: true readOnly: true handicap: type: integer readOnly: true nullable: true required: - color - flag_url - handicap - name - nation_id - non_playable - solo_victory_supply_centers VariantProvince: type: object properties: id: type: string name: type: string type: type: string supply_center: type: boolean parent_id: type: string nullable: true adjacencies: type: array items: $ref: '#/components/schemas/VariantProvinceAdjacency' readOnly: true required: - adjacencies - id - name - parent_id - supply_center - type VariantProvinceAdjacency: type: object properties: to: type: string pass: type: string required: - pass - to VariantTemplateNationRef: type: object properties: name: type: string required: - name VariantTemplatePhase: type: object properties: year: type: integer units: type: array items: $ref: '#/components/schemas/VariantTemplateUnit' supply_centers: type: array items: $ref: '#/components/schemas/VariantTemplateSupplyCenter' required: - supply_centers - units - year VariantTemplateProvinceRef: type: object properties: id: type: string required: - id VariantTemplateSupplyCenter: type: object properties: nation: $ref: '#/components/schemas/VariantTemplateNationRef' province: $ref: '#/components/schemas/VariantTemplateProvinceRef' required: - nation - province VariantTemplateUnit: type: object properties: type: type: string dislodged: type: boolean nation: $ref: '#/components/schemas/VariantTemplateNationRef' province: $ref: '#/components/schemas/VariantTemplateProvinceRef' required: - dislodged - nation - province - type VariantWrite: type: object properties: dvar: type: string format: uri writeOnly: true dsvg: type: string format: uri writeOnly: true required: - dsvg - dvar VerifyEmail: type: object properties: uid: type: string writeOnly: true token: type: string writeOnly: true required: - token - uid Version: type: object properties: environment: type: string version: type: string minimum_client_version: type: string required: - environment - minimum_client_version - version Victory: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true winning_phase_id: type: integer readOnly: true members: type: array items: $ref: '#/components/schemas/Member' readOnly: true required: - id - members - type - winning_phase_id VictoryConditions: type: object properties: solo_victory_supply_centers: type: integer nullable: true game_ends_year: type: integer nullable: true draw_after_year: type: integer nullable: true required: - draw_after_year - game_ends_year - solo_victory_supply_centers WithdrawalReasonEnum: enum: - busy - too_many_games - about_to_be_eliminated - losing_position - dislike_nation - not_enjoying - other type: string description: |- * `busy` - I'm busy with things outside of Diplomacy * `too_many_games` - I'm in too many games * `about_to_be_eliminated` - I'm about to be eliminated * `losing_position` - I think I'm going to lose * `dislike_nation` - I don't like my nation * `not_enjoying` - I'm not enjoying this game * `other` - Something else securitySchemes: jwtAuth: type: http scheme: bearer bearerFormat: JWT