agones.dev/agones@v1.54.0/sdks/swagger/beta.swagger.json (about)

     1  {
     2    "swagger": "2.0",
     3    "info": {
     4      "title": "beta.proto",
     5      "version": "version not set"
     6    },
     7    "tags": [
     8      {
     9        "name": "SDK"
    10      }
    11    ],
    12    "schemes": [
    13      "http"
    14    ],
    15    "consumes": [
    16      "application/json"
    17    ],
    18    "produces": [
    19      "application/json"
    20    ],
    21    "paths": {
    22      "/v1beta1/counters/{counterUpdateRequest.name}": {
    23        "patch": {
    24          "summary": "UpdateCounter returns the updated Counter. Returns NOT_FOUND if the Counter does not exist (name cannot be updated).\nReturns OUT_OF_RANGE if the Count is out of range [0,Capacity].",
    25          "operationId": "UpdateCounter",
    26          "responses": {
    27            "200": {
    28              "description": "A successful response.",
    29              "schema": {
    30                "$ref": "#/definitions/betaCounter"
    31              }
    32            }
    33          },
    34          "parameters": [
    35            {
    36              "name": "counterUpdateRequest.name",
    37              "description": "The name of the Counter to update",
    38              "in": "path",
    39              "required": true,
    40              "type": "string"
    41            },
    42            {
    43              "name": "counterUpdateRequest",
    44              "description": "The requested update to make to the Counter",
    45              "in": "body",
    46              "required": true,
    47              "schema": {
    48                "type": "object",
    49                "properties": {
    50                  "count": {
    51                    "type": "string",
    52                    "format": "int64",
    53                    "title": "The value to set the Counter Count"
    54                  },
    55                  "capacity": {
    56                    "type": "string",
    57                    "format": "int64",
    58                    "title": "The value to set the Counter Capacity"
    59                  },
    60                  "countDiff": {
    61                    "type": "string",
    62                    "format": "int64",
    63                    "title": "countDiff tracks if a Counter Update Request is CountIncrement (positive), CountDecrement\n(negative), 0 if a CountSet or CapacitySet request"
    64                  }
    65                },
    66                "title": "The requested update to make to the Counter",
    67                "required": [
    68                  "counterUpdateRequest"
    69                ]
    70              }
    71            }
    72          ],
    73          "tags": [
    74            "SDK"
    75          ]
    76        }
    77      },
    78      "/v1beta1/counters/{name}": {
    79        "get": {
    80          "summary": "Gets a Counter. Returns NOT_FOUND if the Counter does not exist.",
    81          "operationId": "GetCounter",
    82          "responses": {
    83            "200": {
    84              "description": "A successful response.",
    85              "schema": {
    86                "$ref": "#/definitions/betaCounter"
    87              }
    88            }
    89          },
    90          "parameters": [
    91            {
    92              "name": "name",
    93              "description": "The name of the Counter to get",
    94              "in": "path",
    95              "required": true,
    96              "type": "string"
    97            }
    98          ],
    99          "tags": [
   100            "SDK"
   101          ]
   102        }
   103      },
   104      "/v1beta1/lists/{list.name}": {
   105        "patch": {
   106          "summary": "UpdateList returns the updated List. Returns NOT_FOUND if the List does not exist (name cannot be updated).\n**THIS WILL OVERWRITE ALL EXISTING LIST.VALUES WITH ANY REQUEST LIST.VALUES**\nUse AddListValue() or RemoveListValue() for modifying the List.Values field.\nReturns INVALID_ARGUMENT if the field mask path(s) are not field(s) of the List.\nIf a field mask path(s) is specified, but the value is not set in the request List object,\nthen the default value for the variable will be set (i.e. 0 for \"capacity\", empty list for \"values\").",
   107          "operationId": "UpdateList",
   108          "responses": {
   109            "200": {
   110              "description": "A successful response.",
   111              "schema": {
   112                "$ref": "#/definitions/betaList"
   113              }
   114            }
   115          },
   116          "parameters": [
   117            {
   118              "name": "list.name",
   119              "description": "The name of the List",
   120              "in": "path",
   121              "required": true,
   122              "type": "string"
   123            },
   124            {
   125              "name": "list",
   126              "description": "The List to update",
   127              "in": "body",
   128              "required": true,
   129              "schema": {
   130                "type": "object",
   131                "properties": {
   132                  "capacity": {
   133                    "type": "string",
   134                    "format": "int64",
   135                    "title": "The maximum capacity of the List"
   136                  },
   137                  "values": {
   138                    "type": "array",
   139                    "items": {
   140                      "type": "string"
   141                    },
   142                    "title": "The array of items in the List [\"v1\", \"v2\", …]"
   143                  }
   144                },
   145                "title": "The List to update",
   146                "required": [
   147                  "list"
   148                ]
   149              }
   150            }
   151          ],
   152          "tags": [
   153            "SDK"
   154          ]
   155        }
   156      },
   157      "/v1beta1/lists/{name}": {
   158        "get": {
   159          "summary": "Gets a List. Returns NOT_FOUND if the List does not exist.",
   160          "operationId": "GetList",
   161          "responses": {
   162            "200": {
   163              "description": "A successful response.",
   164              "schema": {
   165                "$ref": "#/definitions/betaList"
   166              }
   167            }
   168          },
   169          "parameters": [
   170            {
   171              "name": "name",
   172              "description": "The name of the List to get",
   173              "in": "path",
   174              "required": true,
   175              "type": "string"
   176            }
   177          ],
   178          "tags": [
   179            "SDK"
   180          ]
   181        }
   182      },
   183      "/v1beta1/lists/{name}:addValue": {
   184        "post": {
   185          "summary": "Adds a value to a List and returns updated List. Returns NOT_FOUND if the List does not exist.\nReturns ALREADY_EXISTS if the value is already in the List.\nReturns OUT_OF_RANGE if the List is already at Capacity.",
   186          "operationId": "AddListValue",
   187          "responses": {
   188            "200": {
   189              "description": "A successful response.",
   190              "schema": {
   191                "$ref": "#/definitions/betaList"
   192              }
   193            }
   194          },
   195          "parameters": [
   196            {
   197              "name": "name",
   198              "description": "The name of the List to add a value to.",
   199              "in": "path",
   200              "required": true,
   201              "type": "string"
   202            },
   203            {
   204              "name": "body",
   205              "in": "body",
   206              "required": true,
   207              "schema": {
   208                "$ref": "#/definitions/SDKAddListValueBody"
   209              }
   210            }
   211          ],
   212          "tags": [
   213            "SDK"
   214          ]
   215        }
   216      },
   217      "/v1beta1/lists/{name}:removeValue": {
   218        "post": {
   219          "summary": "Removes a value from a List and returns updated List. Returns NOT_FOUND if the List does not exist.\nReturns NOT_FOUND if the value is not in the List.",
   220          "operationId": "RemoveListValue",
   221          "responses": {
   222            "200": {
   223              "description": "A successful response.",
   224              "schema": {
   225                "$ref": "#/definitions/betaList"
   226              }
   227            }
   228          },
   229          "parameters": [
   230            {
   231              "name": "name",
   232              "description": "The name of the List to remove a value from.",
   233              "in": "path",
   234              "required": true,
   235              "type": "string"
   236            },
   237            {
   238              "name": "body",
   239              "in": "body",
   240              "required": true,
   241              "schema": {
   242                "$ref": "#/definitions/SDKRemoveListValueBody"
   243              }
   244            }
   245          ],
   246          "tags": [
   247            "SDK"
   248          ]
   249        }
   250      }
   251    },
   252    "definitions": {
   253      "SDKAddListValueBody": {
   254        "type": "object",
   255        "properties": {
   256          "value": {
   257            "type": "string"
   258          }
   259        },
   260        "required": [
   261          "value"
   262        ]
   263      },
   264      "SDKRemoveListValueBody": {
   265        "type": "object",
   266        "properties": {
   267          "value": {
   268            "type": "string"
   269          }
   270        },
   271        "required": [
   272          "value"
   273        ]
   274      },
   275      "betaCounter": {
   276        "type": "object",
   277        "properties": {
   278          "name": {
   279            "type": "string",
   280            "title": "The name of the Counter"
   281          },
   282          "count": {
   283            "type": "string",
   284            "format": "int64",
   285            "title": "The current count of the Counter"
   286          },
   287          "capacity": {
   288            "type": "string",
   289            "format": "int64",
   290            "title": "The maximum capacity of the Counter"
   291          }
   292        },
   293        "description": "A representation of a Counter."
   294      },
   295      "betaCounterUpdateRequest": {
   296        "type": "object",
   297        "properties": {
   298          "name": {
   299            "type": "string",
   300            "title": "The name of the Counter to update"
   301          },
   302          "count": {
   303            "type": "string",
   304            "format": "int64",
   305            "title": "The value to set the Counter Count"
   306          },
   307          "capacity": {
   308            "type": "string",
   309            "format": "int64",
   310            "title": "The value to set the Counter Capacity"
   311          },
   312          "countDiff": {
   313            "type": "string",
   314            "format": "int64",
   315            "title": "countDiff tracks if a Counter Update Request is CountIncrement (positive), CountDecrement\n(negative), 0 if a CountSet or CapacitySet request"
   316          }
   317        },
   318        "description": "A representation of a Counter Update Request."
   319      },
   320      "betaList": {
   321        "type": "object",
   322        "properties": {
   323          "name": {
   324            "type": "string",
   325            "title": "The name of the List"
   326          },
   327          "capacity": {
   328            "type": "string",
   329            "format": "int64",
   330            "title": "The maximum capacity of the List"
   331          },
   332          "values": {
   333            "type": "array",
   334            "items": {
   335              "type": "string"
   336            },
   337            "title": "The array of items in the List [\"v1\", \"v2\", …]"
   338          }
   339        },
   340        "description": "A representation of a List."
   341      }
   342    }
   343  }