alpha.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "alpha.proto",
    "version": "version not set"
  },
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/alpha/player/capacity": {
      "get": {
        "summary": "Retrieves the current player capacity. This is always accurate from what has been set through this SDK,\neven if the value has yet to be updated on the GameServer status resource.",
        "description": "If GameServer.Status.Players.Capacity is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to view this value.",
        "operationId": "GetPlayerCapacity",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/alphaCount"
            }
          }
        },
        "tags": [
          "SDK"
        ]
      },
      "put": {
        "summary": "Update the GameServer.Status.Players.Capacity value with a new capacity.",
        "operationId": "SetPlayerCapacity",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/alphaEmpty"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/alphaCount"
            }
          }
        ],
        "tags": [
          "SDK"
        ]
      }
    },
    "/alpha/player/connect": {
      "post": {
        "summary": "PlayerConnect increases the SDK’s stored player count by one, and appends this playerID to GameServer.Status.Players.IDs.",
        "description": "GameServer.Status.Players.Count and GameServer.Status.Players.IDs are then set to update the player count and id list a second from now,\nunless there is already an update pending, in which case the update joins that batch operation.\n\nPlayerConnect returns true and adds the playerID to the list of playerIDs if this playerID was not already in the\nlist of connected playerIDs.\n\nIf the playerID exists within the list of connected playerIDs, PlayerConnect will return false, and the list of\nconnected playerIDs will be left unchanged.\n\nAn error will be returned if the playerID was not already in the list of connected playerIDs but the player capacity for\nthe server has been reached. The playerID will not be added to the list of playerIDs.\n\nWarning: Do not use this method if you are manually managing GameServer.Status.Players.IDs and GameServer.Status.Players.Count\nthrough the Kubernetes API, as indeterminate results will occur.",
        "operationId": "PlayerConnect",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/alphaBool"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/alphaPlayerID"
            }
          }
        ],
        "tags": [
          "SDK"
        ]
      }
    },
    "/alpha/player/connected": {
      "get": {
        "summary": "Returns the list of the currently connected player ids. This is always accurate from what has been set through this SDK,\neven if the value has yet to be updated on the GameServer status resource.",
        "description": "If GameServer.Status.Players.IDs is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to view this value.",
        "operationId": "GetConnectedPlayers",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/alphaPlayerIDList"
            }
          }
        },
        "tags": [
          "SDK"
        ]
      }
    },
    "/alpha/player/connected/{playerID}": {
      "get": {
        "summary": "Returns if the playerID is currently connected to the GameServer. This is always accurate from what has been set through this SDK,\neven if the value has yet to be updated on the GameServer status resource.",
        "description": "If GameServer.Status.Players.IDs is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to determine connected status.",
        "operationId": "IsPlayerConnected",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/alphaBool"
            }
          }
        },
        "parameters": [
          {
            "name": "playerID",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "SDK"
        ]
      }
    },
    "/alpha/player/count": {
      "get": {
        "summary": "Retrieves the current player count. This is always accurate from what has been set through this SDK,\neven if the value has yet to be updated on the GameServer status resource.",
        "description": "If GameServer.Status.Players.Count is set manually through the Kubernetes API, use SDK.GameServer() or SDK.WatchGameServer() instead to view this value.",
        "operationId": "GetPlayerCount",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/alphaCount"
            }
          }
        },
        "tags": [
          "SDK"
        ]
      }
    },
    "/alpha/player/disconnect": {
      "post": {
        "summary": "Decreases the SDK’s stored player count by one, and removes the playerID from GameServer.Status.Players.IDs.",
        "description": "GameServer.Status.Players.Count and GameServer.Status.Players.IDs are then set to update the player count and id list a second from now,\nunless there is already an update pending, in which case the update joins that batch operation.\n\nPlayerDisconnect will return true and remove the supplied playerID from the list of connected playerIDs if the\nplayerID value exists within the list.\n\nIf the playerID was not in the list of connected playerIDs, the call will return false, and the connected playerID list\nwill be left unchanged.\n\nWarning: Do not use this method if you are manually managing GameServer.status.players.IDs and GameServer.status.players.Count\nthrough the Kubernetes API, as indeterminate results will occur.",
        "operationId": "PlayerDisconnect",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/alphaBool"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/alphaPlayerID"
            }
          }
        ],
        "tags": [
          "SDK"
        ]
      }
    }
  },
  "definitions": {
    "alphaBool": {
      "type": "object",
      "properties": {
        "bool": {
          "type": "boolean",
          "format": "boolean"
        }
      },
      "title": "Store a boolean result"
    },
    "alphaCount": {
      "type": "object",
      "properties": {
        "count": {
          "type": "string",
          "format": "int64"
        }
      },
      "description": "Store a count variable."
    },
    "alphaEmpty": {
      "type": "object",
      "title": "I am Empty"
    },
    "alphaPlayerID": {
      "type": "object",
      "properties": {
        "playerID": {
          "type": "string"
        }
      },
      "description": "The unique identifier for a given player."
    },
    "alphaPlayerIDList": {
      "type": "object",
      "properties": {
        "list": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "title": "List of Player IDs"
    }
  }
}