allocation.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "proto/allocation/allocation.proto",
    "version": "version not set"
  },
  "tags": [
    {
      "name": "AllocationService"
    }
  ],
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/gameserverallocation": {
      "post": {
        "operationId": "Allocate",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/allocationAllocationResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/allocationAllocationRequest"
            }
          }
        ],
        "tags": [
          "AllocationService"
        ]
      }
    }
  },
  "definitions": {
    "AllocationRequestSchedulingStrategy": {
      "type": "string",
      "enum": [
        "Packed",
        "Distributed"
      ],
      "default": "Packed"
    },
    "AllocationResponseGameServerMetadata": {
      "type": "object",
      "properties": {
        "labels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "annotations": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "AllocationResponseGameServerStatusAddress": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      },
      "title": "A single address; identical to corev1.NodeAddress"
    },
    "AllocationResponseGameServerStatusPort": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "port": {
          "type": "integer",
          "format": "int32"
        }
      },
      "description": "The gameserver port info that is allocated."
    },
    "GameServerSelectorGameServerState": {
      "type": "string",
      "enum": [
        "READY",
        "ALLOCATED"
      ],
      "default": "READY"
    },
    "PriorityOrder": {
      "type": "string",
      "enum": [
        "Ascending",
        "Descending"
      ],
      "default": "Ascending"
    },
    "allocationAllocationRequest": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string",
          "title": "The k8s namespace that is hosting the targeted fleet of gameservers to be allocated"
        },
        "multiClusterSetting": {
          "$ref": "#/definitions/allocationMultiClusterSetting",
          "description": "If specified, multi-cluster policies are applied. Otherwise, allocation will happen locally."
        },
        "requiredGameServerSelector": {
          "$ref": "#/definitions/allocationGameServerSelector",
          "description": "Deprecated: Please use gameServerSelectors instead. This field is ignored if the\ngameServerSelectors field is set\nThe required allocation. Defaults to all GameServers."
        },
        "preferredGameServerSelectors": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/allocationGameServerSelector"
          },
          "description": "Deprecated: Please use gameServerSelectors instead. This field is ignored if the\ngameServerSelectors field is set\nThe ordered list of preferred allocations out of the `required` set.\nIf the first selector is not matched, the selection attempts the second selector, and so on."
        },
        "scheduling": {
          "$ref": "#/definitions/AllocationRequestSchedulingStrategy",
          "description": "Scheduling strategy. Defaults to \"Packed\"."
        },
        "metaPatch": {
          "$ref": "#/definitions/allocationMetaPatch",
          "title": "Deprecated: Please use metadata instead. This field is ignored if the\nmetadata field is set"
        },
        "metadata": {
          "$ref": "#/definitions/allocationMetaPatch",
          "title": "Metadata is optional custom metadata that is added to the game server at\nallocation. You can use this to tell the server necessary session data"
        },
        "gameServerSelectors": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/allocationGameServerSelector"
          },
          "description": "Ordered list of GameServer label selectors.\nIf the first selector is not matched, the selection attempts the second selector, and so on.\nThis is useful for things like smoke testing of new game servers.\nNote: This field can only be set if neither Required or Preferred is set."
        },
        "priorities": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/allocationPriority"
          },
          "description": "(Alpha, CountsAndLists feature flag) The first Priority on the array of Priorities is the most\nimportant for sorting. The allocator will use the first priority for sorting GameServers in the\nSelector set, and will only use any following priority for tie-breaking during sort.\nImpacts which GameServer is checked first."
        }
      }
    },
    "allocationAllocationResponse": {
      "type": "object",
      "properties": {
        "gameServerName": {
          "type": "string"
        },
        "ports": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/AllocationResponseGameServerStatusPort"
          }
        },
        "address": {
          "type": "string",
          "title": "Primary address at which game server can be reached"
        },
        "addresses": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/AllocationResponseGameServerStatusAddress"
          },
          "title": "All addresses at which game server can be reached; copy of Node.Status.addresses"
        },
        "nodeName": {
          "type": "string"
        },
        "source": {
          "type": "string"
        },
        "metadata": {
          "$ref": "#/definitions/AllocationResponseGameServerMetadata"
        }
      }
    },
    "allocationCounterSelector": {
      "type": "object",
      "properties": {
        "minCount": {
          "type": "string",
          "format": "int64"
        },
        "maxCount": {
          "type": "string",
          "format": "int64"
        },
        "minAvailable": {
          "type": "string",
          "format": "int64"
        },
        "maxAvailable": {
          "type": "string",
          "format": "int64"
        }
      },
      "title": "CounterSelector is the filter options for a GameServer based on the count and/or available capacity.\n0 for MaxCount or MaxAvailable means unlimited maximum. Default for all fields: 0"
    },
    "allocationGameServerSelector": {
      "type": "object",
      "properties": {
        "matchLabels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Labels to match."
        },
        "gameServerState": {
          "$ref": "#/definitions/GameServerSelectorGameServerState"
        },
        "players": {
          "$ref": "#/definitions/allocationPlayerSelector"
        },
        "counters": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/allocationCounterSelector"
          }
        },
        "lists": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/allocationListSelector"
          }
        }
      },
      "description": "GameServerSelector used for finding a GameServer with matching filters."
    },
    "allocationLabelSelector": {
      "type": "object",
      "properties": {
        "matchLabels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Labels to match."
        }
      },
      "description": "LabelSelector used for finding a GameServer with matching labels."
    },
    "allocationListSelector": {
      "type": "object",
      "properties": {
        "containsValue": {
          "type": "string"
        },
        "minAvailable": {
          "type": "string",
          "format": "int64"
        },
        "maxAvailable": {
          "type": "string",
          "format": "int64"
        }
      },
      "title": "ListSelector is the filter options for a GameServer based on List available capacity and/or the\nexistence of a value in a List.\n0 for MaxAvailable means unlimited maximum. Default for integer fields: 0\n\"\" for ContainsValue means ignore field. Default for string field: \"\""
    },
    "allocationMetaPatch": {
      "type": "object",
      "properties": {
        "labels": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "annotations": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "title": "MetaPatch is the metadata used to patch the GameServer metadata on allocation"
    },
    "allocationMultiClusterSetting": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "format": "boolean",
          "description": "If set to true, multi-cluster allocation is enabled."
        },
        "policySelector": {
          "$ref": "#/definitions/allocationLabelSelector",
          "description": "Selects multi-cluster allocation policies to apply. If not specified, all multi-cluster allocation policies are to be applied."
        }
      },
      "description": "Specifies settings for multi-cluster allocation."
    },
    "allocationPlayerSelector": {
      "type": "object",
      "properties": {
        "minAvailable": {
          "type": "string",
          "format": "uint64"
        },
        "maxAvailable": {
          "type": "string",
          "format": "uint64"
        }
      },
      "description": "PlayerSelector is filter for player capacity values.\nminAvailable should always be less or equal to maxAvailable."
    },
    "allocationPriority": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/definitions/allocationPriorityType"
        },
        "key": {
          "type": "string"
        },
        "order": {
          "$ref": "#/definitions/PriorityOrder"
        }
      },
      "description": "Priority is a sorting option for GameServers with Counters or Lists based on the Capacity.\nType: Sort by a \"Counter\" or a \"List\".\nKey: The name of the Counter or List. If not found on the GameServer, has no impact.\nOrder: Sort by \"Ascending\" or \"Descending\". \"Descending\" a bigger Capacity is preferred.\n\"Ascending\" would be smaller Capacity is preferred."
    },
    "allocationPriorityType": {
      "type": "string",
      "enum": [
        "Counter",
        "List"
      ],
      "default": "Counter"
    }
  }
}