openapi: 3.0.3 info: title: '' version: 0.0.0 paths: /api/schema/: get: operationId: apiSchemaRetrieve 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: apiTokenRefreshCreate 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: authAppleLoginCreate 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: authEmailLoginCreate 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: authLoginCreate 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: authPasswordResetCreate 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: authPasswordResetConfirmCreate 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: authRegisterCreate 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: authVerifyEmailCreate 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: blogList 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: blogRetrieve 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: devicesList tags: - devices security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FCMDevice' description: '' post: operationId: devicesCreate 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: devicesUpdate 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: gameCreate 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/{gameId}/: get: operationId: gameRetrieve parameters: - in: path name: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/GameRetrieve' description: '' /game/{gameId}/addable-user/: get: operationId: gameAddableUserList 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AddableUser' description: '' /game/{gameId}/clone-to-sandbox/: post: operationId: gameCloneToSandboxCreate 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: gameId 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/{gameId}/confirm-phase/: put: operationId: gameConfirmPhaseUpdate 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: gameId 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: gameConfirmPhasePartialUpdate 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: gameId 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/{gameId}/delete/: delete: operationId: gameDeleteDestroy 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{gameId}/extend-deadline/: put: operationId: gameExtendDeadlineUpdate 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: gameId 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: gameExtendDeadlinePartialUpdate 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: gameId 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/{gameId}/kick/{memberId}/: delete: operationId: gameKickDestroy 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: gameId schema: type: string required: true - in: path name: memberId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{gameId}/leave/: delete: operationId: gameLeaveDestroy 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{gameId}/member/: post: operationId: gameMemberCreate 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: gameId 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/{gameId}/member/{memberId}/: get: operationId: gameMemberRetrieve 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: gameId schema: type: string required: true - in: path name: memberId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MemberDetail' description: '' /game/{gameId}/member/{memberId}/nation/: put: operationId: gameMemberNationUpdate 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: gameId schema: type: string required: true - in: path name: memberId 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: gameMemberNationDestroy 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: gameId schema: type: string required: true - in: path name: memberId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{gameId}/member/{memberId}/rating/: get: operationId: gameMemberRatingRetrieve 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: gameId schema: type: string required: true - in: path name: memberId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RatingResultOutput' description: '' /game/{gameId}/member/{memberId}/report/: post: operationId: gameMemberReportCreate parameters: - in: path name: gameId schema: type: string required: true - in: path name: memberId 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/{gameId}/member/join/: post: operationId: gameMemberJoinCreate 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{gameId}/member/nation-preference/: get: operationId: gameMemberNationPreferenceRetrieve 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MemberNationPreference' description: '' put: operationId: gameMemberNationPreferenceUpdate 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: gameId 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/{gameId}/member/withdraw/: put: operationId: gameMemberWithdrawUpdate description: Withdraw the requesting user from an active game, leaving their seat vacant for another player to claim. parameters: - in: path name: gameId 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: gameMemberWithdrawPartialUpdate description: Withdraw the requesting user from an active game, leaving their seat vacant for another player to claim. parameters: - in: path name: gameId 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/{gameId}/members/{memberId}/replace/: post: operationId: gameMembersReplaceCreate 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: gameId schema: type: string required: true - in: path name: memberId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{gameId}/muster/: post: operationId: gameMusterCreate description: Confirm the requesting user's seat in a mustering game. parameters: - in: path name: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Member' description: '' /game/{gameId}/options/: get: operationId: gameOptionsRetrieve 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrderOptionsResponse' description: '' /game/{gameId}/orders/: post: operationId: gameOrdersCreate 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: gameId 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/{gameId}/orders/{phaseId}: get: operationId: gameOrdersList 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: gameId schema: type: string required: true - in: path name: phaseId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Order' description: '' /game/{gameId}/orders/delete/{sourceId}: delete: operationId: gameOrdersDeleteDestroy 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: gameId schema: type: string required: true - in: path name: sourceId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '204': description: No response body /game/{gameId}/pause/: put: operationId: gamePauseUpdate 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body patch: operationId: gamePausePartialUpdate 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body /game/{gameId}/phase-states/: get: operationId: gamePhaseStatesList 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PhaseState' description: '' /game/{gameId}/phase/{phaseId}/: get: operationId: gamePhaseRetrieve description: Retrieve a phase with its units, supply centers and province ownership. parameters: - in: path name: gameId schema: type: string required: true - in: path name: phaseId schema: type: integer required: true tags: - game security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseRetrieve' description: '' /game/{gameId}/phase/{phaseId}/revert/: put: operationId: gamePhaseRevertUpdate 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: gameId schema: type: string required: true - in: path name: phaseId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseList' description: '' patch: operationId: gamePhaseRevertPartialUpdate 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: gameId schema: type: string required: true - in: path name: phaseId schema: type: integer required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseList' description: '' /game/{gameId}/phases/: get: operationId: gamePhasesList 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PhaseList' description: '' /game/{gameId}/resolve-phase/: post: operationId: gameResolvePhaseCreate 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhaseList' description: '' /game/{gameId}/unpause/: put: operationId: gameUnpauseUpdate 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body patch: operationId: gameUnpausePartialUpdate 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: gameId schema: type: string required: true tags: - game security: - jwtAuth: [] responses: '200': description: No response body /games/: get: operationId: gamesList 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/{gameId}/channel-previews/: get: operationId: gamesChannelPreviewsList description: List the channels the requester can read, each with only its latest message. parameters: - in: path name: gameId schema: type: string required: true tags: - games security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ChannelPreview' description: '' /games/{gameId}/channels/{channelId}/: get: operationId: gamesChannelsRetrieve description: Retrieve a channel without its message history, or rename a private channel. parameters: - in: path name: channelId schema: type: integer required: true - in: path name: gameId schema: type: string required: true tags: - games security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChannelDetail' description: '' put: operationId: gamesChannelsUpdate description: Retrieve a channel without its message history, or rename a private channel. parameters: - in: path name: channelId schema: type: integer required: true - in: path name: gameId 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: gamesChannelsPartialUpdate description: Retrieve a channel without its message history, or rename a private channel. parameters: - in: path name: channelId schema: type: integer required: true - in: path name: gameId 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/{gameId}/channels/{channelId}/leave/: post: operationId: gamesChannelsLeaveCreate description: Leave a private channel. A member who leaves cannot rejoin. parameters: - in: path name: channelId schema: type: integer required: true - in: path name: gameId schema: type: string required: true tags: - games security: - jwtAuth: [] responses: '201': description: No response body /games/{gameId}/channels/{channelId}/mark-read/: post: operationId: gamesChannelsMarkReadCreate 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: channelId schema: type: integer required: true - in: path name: gameId schema: type: string required: true tags: - games security: - jwtAuth: [] responses: '201': description: No response body /games/{gameId}/channels/{channelId}/messages/: get: operationId: gamesChannelsMessagesRetrieve 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: channelId schema: type: integer required: true - in: path name: gameId 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/{gameId}/channels/{channelId}/messages/create/: post: operationId: gamesChannelsMessagesCreateCreate 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: channelId schema: type: integer required: true - in: path name: gameId 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/{gameId}/channels/{channelId}/mute/: put: operationId: gamesChannelsMuteUpdate description: Mute or unmute notifications for a channel. parameters: - in: path name: channelId schema: type: integer required: true - in: path name: gameId 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: gamesChannelsMutePartialUpdate description: Mute or unmute notifications for a channel. parameters: - in: path name: channelId schema: type: integer required: true - in: path name: gameId 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/{gameId}/channels/create/: post: operationId: gamesChannelsCreateCreate 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: gameId 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/{gameId}/draw-proposals/: get: operationId: gamesDrawProposalsList 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: gameId schema: type: string required: true tags: - games security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DrawProposal' description: '' /games/{gameId}/draw-proposals/{proposalId}/cancel/: delete: operationId: gamesDrawProposalsCancelDestroy 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: gameId schema: type: string required: true - in: path name: proposalId schema: type: integer required: true tags: - games security: - jwtAuth: [] responses: '204': description: No response body /games/{gameId}/draw-proposals/{proposalId}/vote/: put: operationId: gamesDrawProposalsVoteUpdate 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: gameId schema: type: string required: true - in: path name: proposalId 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: gamesDrawProposalsVotePartialUpdate 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: gameId schema: type: string required: true - in: path name: proposalId 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/{gameId}/draw-proposals/create/: post: operationId: gamesDrawProposalsCreateCreate 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: gameId 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: gamesFastestRetrieve 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: gamesFindSimilarRetrieve 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: gamesMineCurrentRetrieve 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: gamesMineFinishedList 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: leaderboardList 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: moderationReportsList 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: moderationReportsRetrieve 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: moderationReportsApproveCreate 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: moderationReportsAssignCreate 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: moderationReportsRejectCreate 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: moderationReportsReopenCreate 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: moderationReportsUnassignCreate 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: reportReasonsList tags: - report security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ReportReason' description: '' /sandbox-game/: post: operationId: sandboxGameCreate 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: updateCheckCreate 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: userRetrieve tags: - user security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserProfile' description: '' /user/delete/: delete: operationId: userDeleteDestroy tags: - user security: - jwtAuth: [] responses: '204': description: No response body /user/picture/: put: operationId: userPictureUpdate 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: userPictureDestroy 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: userUpdateUpdate 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: userUpdatePartialUpdate 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/{userId}/: get: operationId: usersRetrieve parameters: - in: path name: userId schema: type: integer required: true tags: - users security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicUserProfile' description: '' /variants/: get: operationId: variantsList tags: - variants security: - jwtAuth: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Variant' description: '' post: operationId: variantsCreate 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: variantsRetrieve 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: variantsUpdate 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: variantsPartialUpdate 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: variantsDestroy parameters: - in: path name: id schema: type: string required: true tags: - variants security: - jwtAuth: [] responses: '204': description: No response body /variants/{variantId}/dvar/: get: operationId: variantsDvarRetrieve parameters: - in: path name: variantId schema: type: string required: true tags: - variants security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Variant' description: '' /variants/{variantId}/nations/{nationId}/flag/: put: operationId: variantsNationsFlagUpdate parameters: - in: path name: nationId schema: type: string required: true - in: path name: variantId 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: variantsNationsFlagDestroy parameters: - in: path name: nationId schema: type: string required: true - in: path name: variantId schema: type: string required: true tags: - variants security: - jwtAuth: [] responses: '204': description: No response body /variants/mine/: get: operationId: variantsMineList tags: - variants security: - jwtAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Variant' description: '' /version/: get: operationId: versionRetrieve tags: - version security: - jwtAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Version' description: '' components: schemas: AddableUser: type: object properties: userId: type: integer readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true required: - name - picture - userId AppleAuth: type: object properties: idToken: type: string writeOnly: true firstName: type: string writeOnly: true lastName: type: string writeOnly: true id: type: integer readOnly: true email: type: string readOnly: true name: type: string readOnly: true accessToken: type: string readOnly: true refreshToken: type: string readOnly: true required: - accessToken - email - id - idToken - name - refreshToken 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 createdAt: type: string format: date-time readOnly: true required: - createdAt - 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 createdAt: type: string format: date-time readOnly: true required: - body - createdAt - 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 unreadMessageCount: type: integer readOnly: true default: 0 muted: type: boolean readOnly: true default: false canRename: type: boolean readOnly: true canMute: type: boolean readOnly: true canLeave: type: boolean readOnly: true memberIds: type: array items: type: integer writeOnly: true required: - canLeave - canMute - canRename - events - id - memberIds - messages - muted - name - private - unreadMessageCount 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 canMute: type: boolean readOnly: true canRename: type: boolean readOnly: true canLeave: type: boolean readOnly: true unreadMessageCount: type: integer readOnly: true firstUnreadMessageId: type: integer readOnly: true nullable: true latestMessageId: type: integer readOnly: true nullable: true latestEventId: type: integer readOnly: true nullable: true events: type: array items: $ref: '#/components/schemas/ChannelEvent' readOnly: true required: - canLeave - canMute - canRename - events - firstUnreadMessageId - id - latestEventId - latestMessageId - muted - name - private - title - unreadMessageCount ChannelEvent: type: object properties: id: type: integer readOnly: true text: type: string readOnly: true createdAt: type: string format: date-time readOnly: true required: - createdAt - id - text ChannelMember: type: object properties: id: type: integer readOnly: true userId: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true isCurrentUser: type: boolean readOnly: true isBot: type: boolean readOnly: true botKind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' nation: allOf: - $ref: '#/components/schemas/Nation' nullable: true isGameMaster: type: boolean readOnly: true required: - botKind - id - isBot - isCurrentUser - isGameMaster - name - nation - picture - userId ChannelMessage: type: object properties: id: type: integer readOnly: true body: type: string maxLength: 500 clientMessageId: type: string format: uuid nullable: true sender: allOf: - $ref: '#/components/schemas/ChannelMember' readOnly: true createdAt: type: string format: date-time readOnly: true required: - body - createdAt - id - sender ChannelMessagePage: type: object properties: results: type: array items: $ref: '#/components/schemas/ChannelMessage' readOnly: true hasOlder: type: boolean readOnly: true hasNewer: type: boolean readOnly: true required: - hasNewer - hasOlder - results ChannelMute: type: object properties: muted: type: boolean readOnly: true muteDuration: writeOnly: true nullable: true oneOf: - $ref: '#/components/schemas/MuteDurationEnum' - $ref: '#/components/schemas/NullEnum' required: - muteDuration - 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 unreadMessageCount: type: integer readOnly: true latestMessage: allOf: - $ref: '#/components/schemas/ChannelMessage' readOnly: true nullable: true required: - id - latestMessage - muted - name - private - title - unreadMessageCount 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 gameName: 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 - gameName - 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 createdBy: allOf: - $ref: '#/components/schemas/DrawVoteMember' readOnly: true status: type: string readOnly: true acceptedCount: type: integer readOnly: true rejectedCount: type: integer readOnly: true pendingCount: type: integer readOnly: true totalVotes: type: integer readOnly: true includedMemberIds: type: array items: type: integer readOnly: true myVote: allOf: - $ref: '#/components/schemas/MyVote' nullable: true readOnly: true phaseId: type: integer readOnly: true phaseName: type: string readOnly: true createdAt: type: string format: date-time readOnly: true required: - acceptedCount - createdAt - createdBy - id - includedMemberIds - myVote - pendingCount - phaseId - phaseName - rejectedCount - status - totalVotes DrawVoteMember: type: object properties: id: type: integer readOnly: true userId: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true isCurrentUser: type: boolean readOnly: true isBot: type: boolean readOnly: true botKind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' nation: type: string nullable: true required: - botKind - id - isBot - isCurrentUser - name - nation - picture - userId 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 accessToken: type: string readOnly: true refreshToken: type: string readOnly: true required: - accessToken - email - id - name - password - refreshToken FCMDevice: type: object properties: id: type: integer readOnly: true name: type: string nullable: true maxLength: 255 registrationId: type: string title: Registration token deviceId: 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 dateCreated: type: string format: date-time readOnly: true nullable: true title: Creation date type: $ref: '#/components/schemas/TypeEnum' required: - dateCreated - id - registrationId - 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 orderType: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true target: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true aux: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true unitType: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true namedCoast: allOf: - $ref: '#/components/schemas/FieldValue' nullable: true required: - aux - namedCoast - orderType - source - target - unitType GameAction: type: object properties: key: allOf: - $ref: '#/components/schemas/GameActionKeyEnum' readOnly: true blockedReason: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' required: - blockedReason - 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 variantId: type: string movementPhaseDuration: allOf: - $ref: '#/components/schemas/DurationEnum' default: 24 hours retreatPhaseDuration: nullable: true oneOf: - $ref: '#/components/schemas/DurationEnum' - $ref: '#/components/schemas/NullEnum' private: type: boolean anonymous: type: boolean default: false ranked: type: boolean default: false gameMaster: type: boolean default: false deadlineMode: allOf: - $ref: '#/components/schemas/DeadlineModeEnum' default: fixed_time fixedDeadlineTime: type: string format: time nullable: true fixedDeadlineTimezone: type: string nullable: true maxLength: 50 movementFrequency: nullable: true oneOf: - $ref: '#/components/schemas/MovementFrequencyEnum' - $ref: '#/components/schemas/NullEnum' retreatFrequency: nullable: true oneOf: - $ref: '#/components/schemas/RetreatFrequencyEnum' - $ref: '#/components/schemas/NullEnum' nmrExtensionsAllowed: type: integer maximum: 2 minimum: 0 default: 0 pressType: allOf: - $ref: '#/components/schemas/PressTypeEnum' default: full_press commitmentRequirement: allOf: - $ref: '#/components/schemas/CommitmentRequirementEnum' default: open required: - id - name - private - variantId GameCreateSandbox: type: object properties: id: type: string readOnly: true name: type: string variantId: type: string required: - id - name - variantId 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 createdAt: type: string format: date-time readOnly: true canJoin: type: boolean readOnly: true canLeave: type: boolean readOnly: true canWithdraw: type: boolean readOnly: true canDelete: type: boolean readOnly: true canManage: type: boolean readOnly: true gameMaster: allOf: - $ref: '#/components/schemas/GameMaster' readOnly: true nullable: true variantId: type: string readOnly: true phases: type: array items: type: integer readOnly: true currentPhaseId: type: integer nullable: true readOnly: true currentPhase: allOf: - $ref: '#/components/schemas/GameListCurrentPhase' nullable: true readOnly: true phaseConfirmed: type: boolean readOnly: true orderStatus: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/OrderStatusEnum' - $ref: '#/components/schemas/NullEnum' memberStatus: 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 movementPhaseDuration: type: string readOnly: true nullable: true retreatPhaseDuration: type: string readOnly: true nullable: true showShortGameJoinWarning: 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 isPaused: type: boolean readOnly: true pausedAt: type: string format: date-time readOnly: true nullable: true nmrExtensionsAllowed: type: integer readOnly: true deadlineMode: type: string readOnly: true fixedDeadlineTime: type: string format: time readOnly: true nullable: true fixedDeadlineTimezone: type: string readOnly: true nullable: true movementFrequency: type: string readOnly: true nullable: true retreatFrequency: type: string readOnly: true nullable: true pressType: type: string readOnly: true commitmentRequirement: type: string readOnly: true joinBlockedReason: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' musterRequired: type: boolean readOnly: true musterDeadline: type: string format: date-time readOnly: true nullable: true musterStatus: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/MusterStatusEnum' - $ref: '#/components/schemas/NullEnum' totalUnreadMessageCount: type: integer readOnly: true default: 0 required: - anonymous - canDelete - canJoin - canLeave - canManage - canWithdraw - commitmentRequirement - createdAt - currentPhase - currentPhaseId - deadlineMode - fixedDeadlineTime - fixedDeadlineTimezone - gameMaster - id - isPaused - joinBlockedReason - memberStatus - members - movementFrequency - movementPhaseDuration - musterDeadline - musterRequired - musterStatus - name - nmrExtensionsAllowed - orderStatus - pausedAt - phaseConfirmed - phases - pressType - private - ranked - retreatFrequency - retreatPhaseDuration - sandbox - showShortGameJoinWarning - status - totalUnreadMessageCount - variantId - 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 scheduledResolution: type: string format: date-time readOnly: true nullable: true remainingTime: type: integer readOnly: true units: type: array items: $ref: '#/components/schemas/GameListUnit' readOnly: true supplyCenters: type: array items: $ref: '#/components/schemas/GameListSupplyCenter' readOnly: true required: - id - name - ordinal - remainingTime - scheduledResolution - season - status - supplyCenters - 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: userId: type: integer readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true required: - name - picture - userId GameRetrieve: type: object properties: id: type: string readOnly: true name: type: string readOnly: true status: type: string readOnly: true createdAt: type: string format: date-time readOnly: true canJoin: type: boolean readOnly: true canLeave: type: boolean readOnly: true canWithdraw: type: boolean readOnly: true isFirstYear: type: boolean readOnly: true canDelete: type: boolean readOnly: true canManage: type: boolean readOnly: true canCreateChannel: type: boolean readOnly: true gameMaster: allOf: - $ref: '#/components/schemas/GameMaster' readOnly: true nullable: true gameMasterMemberId: type: integer nullable: true readOnly: true phases: type: array items: type: integer readOnly: true currentPhaseId: 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 variantId: type: string readOnly: true phaseConfirmed: type: boolean readOnly: true orderStatus: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/OrderStatusEnum' - $ref: '#/components/schemas/NullEnum' memberStatus: type: array items: $ref: '#/components/schemas/MemberStatusEnum' nullable: true readOnly: true movementPhaseDuration: type: string readOnly: true nullable: true retreatPhaseDuration: type: string readOnly: true nullable: true showShortGameJoinWarning: type: boolean readOnly: true private: type: boolean readOnly: true anonymous: type: boolean readOnly: true ranked: type: boolean readOnly: true isPaused: type: boolean readOnly: true pausedAt: type: string format: date-time readOnly: true nullable: true nmrExtensionsAllowed: type: integer readOnly: true deadlineMode: type: string readOnly: true fixedDeadlineTime: type: string format: time readOnly: true nullable: true fixedDeadlineTimezone: type: string readOnly: true nullable: true movementFrequency: type: string readOnly: true nullable: true retreatFrequency: type: string readOnly: true nullable: true pressType: type: string readOnly: true commitmentRequirement: type: string readOnly: true joinBlockedReason: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' musterRequired: type: boolean readOnly: true musterDeadline: type: string format: date-time readOnly: true nullable: true musterStatus: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/MusterStatusEnum' - $ref: '#/components/schemas/NullEnum' totalUnreadMessageCount: type: integer readOnly: true actions: type: array items: $ref: '#/components/schemas/GameAction' readOnly: true playerListActions: type: array items: $ref: '#/components/schemas/GameAction' readOnly: true required: - actions - anonymous - canCreateChannel - canDelete - canJoin - canLeave - canManage - canWithdraw - commitmentRequirement - createdAt - currentPhaseId - deadlineMode - fixedDeadlineTime - fixedDeadlineTimezone - gameMaster - gameMasterMemberId - id - isFirstYear - isPaused - joinBlockedReason - memberStatus - members - movementFrequency - movementPhaseDuration - musterDeadline - musterRequired - musterStatus - name - nmrExtensionsAllowed - orderStatus - pausedAt - phaseConfirmed - phases - playerListActions - pressType - private - ranked - retreatFrequency - retreatPhaseDuration - sandbox - showShortGameJoinWarning - status - totalUnreadMessageCount - variantId - victory GoogleAuth: type: object properties: idToken: type: string writeOnly: true id: type: integer readOnly: true email: type: string readOnly: true name: type: string readOnly: true accessToken: type: string readOnly: true refreshToken: type: string readOnly: true required: - accessToken - email - id - idToken - name - refreshToken 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 userId: 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 - userId Mark: type: object properties: reason: allOf: - $ref: '#/components/schemas/ReasonEnum' readOnly: true createdAt: type: string format: date-time readOnly: true required: - createdAt - reason Member: type: object properties: id: type: integer readOnly: true userId: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true isCurrentUser: type: boolean readOnly: true isBot: type: boolean readOnly: true botKind: 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 isGameCreator: type: boolean readOnly: true isAdmin: type: boolean readOnly: true nmrExtensionsRemaining: type: integer readOnly: true civilDisorder: type: boolean readOnly: true withdrawn: type: boolean readOnly: true seekingReplacement: type: boolean readOnly: true replaceable: type: boolean readOnly: true seatConfirmed: type: boolean readOnly: true nullable: true removable: type: boolean readOnly: true nationPreferenceIds: type: array items: type: string readOnly: true commitmentTotal: type: integer nullable: true readOnly: true commitmentBand: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/CommitmentBandEnum' - $ref: '#/components/schemas/NullEnum' ratingChange: type: integer nullable: true readOnly: true ratingBefore: type: integer nullable: true readOnly: true ratingAfter: type: integer nullable: true readOnly: true required: - botKind - civilDisorder - commitmentBand - commitmentTotal - eliminated - id - isAdmin - isBot - isCurrentUser - isGameCreator - kicked - name - nation - nationPreferenceIds - nmrExtensionsRemaining - picture - ratingAfter - ratingBefore - ratingChange - removable - replaceable - seatConfirmed - seekingReplacement - userId - withdrawn MemberAction: type: object properties: key: allOf: - $ref: '#/components/schemas/MemberActionKeyEnum' readOnly: true blockedReason: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/BlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' required: - blockedReason - 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: userId: type: integer writeOnly: true required: - userId MemberDetail: type: object properties: id: type: integer readOnly: true userId: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true isCurrentUser: type: boolean readOnly: true isBot: type: boolean readOnly: true botKind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' isAdmin: type: boolean readOnly: true nation: type: string readOnly: true nullable: true participationStatus: allOf: - $ref: '#/components/schemas/ParticipationStatusEnum' readOnly: true supplyCenterCount: type: integer nullable: true readOnly: true unitCount: type: integer nullable: true readOnly: true nmrExtensionsRemaining: type: integer readOnly: true nmrExtensionsAllowed: type: integer readOnly: true nationPreferences: type: array items: type: string nullable: true readOnly: true actions: type: array items: $ref: '#/components/schemas/MemberAction' readOnly: true canReport: type: boolean readOnly: true alreadyReported: type: boolean readOnly: true rated: type: boolean readOnly: true required: - actions - alreadyReported - botKind - canReport - id - isAdmin - isBot - isCurrentUser - name - nation - nationPreferences - nmrExtensionsAllowed - nmrExtensionsRemaining - participationStatus - picture - rated - supplyCenterCount - unitCount - userId MemberNationAssign: type: object properties: nationId: type: string writeOnly: true required: - nationId MemberNationPreference: type: object properties: nationIds: type: array items: type: string required: - nationIds 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 userId: type: integer nullable: true readOnly: true name: type: string readOnly: true nullable: true nation: type: string readOnly: true nullable: true required: - id - name - nation - userId ModerationReportAction: type: object properties: key: $ref: '#/components/schemas/ModerationReportActionKeyEnum' blockedReason: nullable: true oneOf: - $ref: '#/components/schemas/ModerationReportActionBlockedReasonEnum' - $ref: '#/components/schemas/NullEnum' required: - blockedReason - 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 createdAt: type: string format: date-time readOnly: true gameId: type: string readOnly: true gameName: type: string readOnly: true variantName: 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 assignedTo: allOf: - $ref: '#/components/schemas/ModerationReviewerOutput' readOnly: true nullable: true actions: type: array items: $ref: '#/components/schemas/ModerationReportAction' readOnly: true canViewGame: type: boolean readOnly: true required: - actions - assignedTo - canViewGame - createdAt - gameId - gameName - id - note - reason - reported - reporter - review - status - variantName ModerationReviewOutput: type: object properties: reviewedBy: allOf: - $ref: '#/components/schemas/ModerationReviewerOutput' readOnly: true note: type: string readOnly: true maxLength: 1000 createdAt: type: string format: date-time readOnly: true required: - createdAt - note - reviewedBy ModerationReviewerOutput: type: object properties: userId: type: integer readOnly: true name: type: string readOnly: true required: - name - userId 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 variantId: type: string readOnly: true sandbox: type: boolean readOnly: true currentPhaseId: type: integer readOnly: true nullable: true currentPhase: 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 unreadCount: type: integer readOnly: true state: allOf: - $ref: '#/components/schemas/MyGameState' readOnly: true required: - currentPhase - currentPhaseId - id - name - nation - sandbox - seats - state - status - unreadCount - variantId 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: nationId: type: string name: type: string color: type: string readOnly: true nonPlayable: type: boolean flagUrl: type: string format: uri nullable: true readOnly: true required: - color - flagUrl - name - nationId - nonPlayable 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 sourceCoast: allOf: - $ref: '#/components/schemas/Province' readOnly: true nullable: true target: allOf: - $ref: '#/components/schemas/Province' readOnly: true targetCoast: allOf: - $ref: '#/components/schemas/Province' readOnly: true nullable: true aux: allOf: - $ref: '#/components/schemas/Province' readOnly: true namedCoast: allOf: - $ref: '#/components/schemas/Province' readOnly: true resolution: allOf: - $ref: '#/components/schemas/OrderResolution' readOnly: true orderType: allOf: - $ref: '#/components/schemas/OrderTypeEnum' readOnly: true unitType: allOf: - $ref: '#/components/schemas/UnitTypeEnum' readOnly: true nation: allOf: - $ref: '#/components/schemas/Nation' readOnly: true isImplicit: 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 - isImplicit - namedCoast - nation - orderType - resolution - source - sourceCoast - step - summary - target - targetCoast - title - unitType OrderOptionsResponse: type: object properties: orders: type: array items: $ref: '#/components/schemas/FlatOrderOption' fieldOrder: type: object additionalProperties: type: array items: type: string required: - fieldOrder - 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 newPassword: type: string writeOnly: true minLength: 8 confirmPassword: type: string writeOnly: true minLength: 8 required: - confirmPassword - newPassword - token - uid PatchedChannelMute: type: object properties: muted: type: boolean readOnly: true muteDuration: 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 ordersConfirmed: type: boolean readOnly: true eliminated: type: boolean readOnly: true orderableProvinces: type: array items: $ref: '#/components/schemas/Province' readOnly: true member: allOf: - $ref: '#/components/schemas/Member' readOnly: true maxOrders: type: integer nullable: true readOnly: true PatchedUserProfile: type: object properties: id: type: integer readOnly: true userId: type: integer readOnly: true name: type: string maxLength: 255 minLength: 2 picture: type: string nullable: true readOnly: true email: type: string readOnly: true canCreateBotGames: type: boolean readOnly: true isModerator: type: boolean readOnly: true canCreateCommittedGame: 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 remainingTime: type: integer scheduledResolution: type: string format: date-time status: $ref: '#/components/schemas/StatusEnum' units: type: array items: $ref: '#/components/schemas/Unit' supplyCenters: type: array items: $ref: '#/components/schemas/SupplyCenter' previousPhaseId: type: integer nullable: true nextPhaseId: type: integer nullable: true provinceNations: type: string readOnly: true required: - id - name - nextPhaseId - ordinal - previousPhaseId - provinceNations - remainingTime - scheduledResolution - season - status - supplyCenters - type - units - year PhaseState: type: object properties: id: type: string readOnly: true ordersConfirmed: type: boolean readOnly: true eliminated: type: boolean readOnly: true orderableProvinces: type: array items: $ref: '#/components/schemas/Province' readOnly: true member: allOf: - $ref: '#/components/schemas/Member' readOnly: true maxOrders: type: integer nullable: true readOnly: true required: - eliminated - id - maxOrders - member - orderableProvinces - ordersConfirmed 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 supplyCenter: type: boolean parentId: type: string nullable: true namedCoastIds: type: array items: type: string readOnly: true required: - id - name - namedCoastIds - parentId - supplyCenter - type PublicUserProfile: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true botKind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' createdAt: type: string format: date-time nullable: true readOnly: true totalGames: type: integer readOnly: true activeGames: type: integer readOnly: true commitmentTotal: type: integer readOnly: true commitmentBand: allOf: - $ref: '#/components/schemas/CommitmentBandEnum' readOnly: true commitmentSquares: 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: - activeGames - botKind - commitmentBand - commitmentSquares - commitmentTotal - createdAt - id - marks - name - picture - rating - totalGames RatingOpponent: type: object properties: id: type: integer readOnly: true userId: type: integer nullable: true readOnly: true name: type: string readOnly: true picture: type: string nullable: true readOnly: true isCurrentUser: type: boolean readOnly: true isBot: type: boolean readOnly: true botKind: nullable: true readOnly: true oneOf: - $ref: '#/components/schemas/BotKindEnum' - $ref: '#/components/schemas/NullEnum' nation: type: string nullable: true required: - botKind - id - isBot - isCurrentUser - name - nation - picture - userId RatingPairingOutput: type: object properties: id: type: integer readOnly: true opponent: allOf: - $ref: '#/components/schemas/RatingOpponent' readOnly: true opponentRating: type: number format: double readOnly: true score: type: number format: double readOnly: true change: type: number format: double readOnly: true required: - change - id - opponent - opponentRating - score RatingResultOutput: type: object properties: id: type: integer readOnly: true ratingBefore: type: number format: double readOnly: true ratingAfter: type: number format: double readOnly: true ratingChange: 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 - ratingAfter - ratingBefore - ratingChange 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 displayName: type: string writeOnly: true required: - displayName - 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 createdAt: type: string format: date-time readOnly: true required: - createdAt - 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 dislodgedFrom: allOf: - $ref: '#/components/schemas/Province' nullable: true required: - dislodged - dislodgedFrom - 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 versionBuild: type: string writeOnly: true versionName: type: string writeOnly: true required: - platform - versionBuild - versionName 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 userId: type: integer readOnly: true name: type: string maxLength: 255 minLength: 2 picture: type: string nullable: true readOnly: true email: type: string readOnly: true canCreateBotGames: type: boolean readOnly: true isModerator: type: boolean readOnly: true canCreateCommittedGame: type: boolean readOnly: true required: - canCreateBotGames - canCreateCommittedGame - email - id - isModerator - name - picture - userId 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 unitScaling: type: number format: double status: type: string readOnly: true official: type: boolean readOnly: true ranked: type: boolean readOnly: true ownerId: type: integer readOnly: true nullable: true ownerUsername: type: string nullable: true readOnly: true canEdit: type: boolean readOnly: true victoryConditions: $ref: '#/components/schemas/VictoryConditions' svgUrl: type: string nullable: true readOnly: true nations: type: array items: $ref: '#/components/schemas/VariantNation' provinces: type: array items: $ref: '#/components/schemas/VariantProvince' templatePhase: $ref: '#/components/schemas/VariantTemplatePhase' required: - canEdit - description - id - name - nations - official - ownerId - ownerUsername - provinces - ranked - rules - status - svgUrl - templatePhase - unitScaling - victoryConditions VariantNation: type: object properties: nationId: type: string name: type: string color: type: string readOnly: true nonPlayable: type: boolean flagUrl: type: string format: uri nullable: true readOnly: true soloVictorySupplyCenters: type: integer nullable: true readOnly: true handicap: type: integer readOnly: true nullable: true required: - color - flagUrl - handicap - name - nationId - nonPlayable - soloVictorySupplyCenters VariantProvince: type: object properties: id: type: string name: type: string type: type: string supplyCenter: type: boolean parentId: type: string nullable: true adjacencies: type: array items: $ref: '#/components/schemas/VariantProvinceAdjacency' readOnly: true required: - adjacencies - id - name - parentId - supplyCenter - 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' supplyCenters: type: array items: $ref: '#/components/schemas/VariantTemplateSupplyCenter' required: - supplyCenters - 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 minimumClientVersion: type: string required: - environment - minimumClientVersion - version Victory: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true winningPhaseId: type: integer readOnly: true members: type: array items: $ref: '#/components/schemas/Member' readOnly: true required: - id - members - type - winningPhaseId VictoryConditions: type: object properties: soloVictorySupplyCenters: type: integer nullable: true gameEndsYear: type: integer nullable: true drawAfterYear: type: integer nullable: true required: - drawAfterYear - gameEndsYear - soloVictorySupplyCenters 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