GiantsTools/Giants.WebApi.Clients/swagger.json

461 lines
10 KiB
JSON

{
"x-generator": "NSwag v13.16.1.0 (NJsonSchema v10.7.2.0 (Newtonsoft.Json v10.0.0.0))",
"openapi": "3.0.0",
"info": {
"title": "My Title",
"version": "1.0.0"
},
"servers": [
{
"url": "https://localhost:44304"
}
],
"paths": {
"/api/Servers": {
"delete": {
"tags": [
"Servers"
],
"operationId": "Servers_DeleteServer",
"parameters": [
{
"name": "gameName",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "port",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": ""
}
}
},
"get": {
"tags": [
"Servers"
],
"operationId": "Servers_GetServers",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServerInfoWithHostAddress"
}
}
}
}
}
}
},
"post": {
"tags": [
"Servers"
],
"operationId": "Servers_AddServer",
"requestBody": {
"x-name": "serverInfo",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerInfo"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/Branches": {
"get": {
"tags": [
"Branches"
],
"operationId": "Branches_GetBranches",
"parameters": [
{
"name": "appName",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/api/Community": {
"get": {
"tags": [
"Community"
],
"operationId": "Community_GetDiscordStatus",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommunityStatus"
}
}
}
}
}
}
},
"/api/CrashReports": {
"post": {
"tags": [
"CrashReports"
],
"operationId": "CrashReports_Upload",
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/Version": {
"get": {
"tags": [
"Version"
],
"operationId": "Version_GetVersionInfo",
"parameters": [
{
"name": "appName",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 1
},
{
"name": "branchName",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionInfo"
}
}
}
}
}
},
"post": {
"tags": [
"Version"
],
"operationId": "Version_UpdateVersionInfo",
"requestBody": {
"x-name": "versionInfoUpdate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionInfoUpdate"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": ""
}
}
}
}
},
"components": {
"schemas": {
"ServerInfoWithHostAddress": {
"allOf": [
{
"$ref": "#/components/schemas/ServerInfo"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"hostIpAddress"
],
"properties": {
"hostIpAddress": {
"type": "string",
"minLength": 1
}
}
}
]
},
"ServerInfo": {
"type": "object",
"additionalProperties": false,
"required": [
"gameName",
"version",
"sessionName",
"port",
"mapName",
"gameType",
"numPlayers",
"maxPlayers",
"gameState",
"timeLimit",
"fragLimit",
"teamFragLimit",
"firstBaseComplete",
"playerInfo"
],
"properties": {
"gameName": {
"type": "string",
"maxLength": 100,
"minLength": 0
},
"version": {
"$ref": "#/components/schemas/AppVersion"
},
"sessionName": {
"type": "string",
"maxLength": 100,
"minLength": 0
},
"port": {
"type": "integer",
"format": "int32"
},
"mapName": {
"type": "string",
"maxLength": 300,
"minLength": 0
},
"gameType": {
"type": "string",
"maxLength": 100,
"minLength": 0
},
"numPlayers": {
"type": "integer",
"format": "int32"
},
"maxPlayers": {
"type": "integer",
"format": "int32"
},
"gameState": {
"type": "string",
"maxLength": 100,
"minLength": 0
},
"timeLimit": {
"type": "integer",
"format": "int32"
},
"fragLimit": {
"type": "integer",
"format": "int32"
},
"teamFragLimit": {
"type": "integer",
"format": "int32"
},
"firstBaseComplete": {
"type": "boolean"
},
"playerInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlayerInfo"
}
}
}
},
"AppVersion": {
"type": "object",
"additionalProperties": false,
"required": [
"build",
"major",
"minor",
"revision"
],
"properties": {
"build": {
"type": "integer",
"format": "int32"
},
"major": {
"type": "integer",
"format": "int32"
},
"minor": {
"type": "integer",
"format": "int32"
},
"revision": {
"type": "integer",
"format": "int32"
}
}
},
"PlayerInfo": {
"type": "object",
"additionalProperties": false,
"required": [
"index",
"name",
"frags",
"deaths",
"teamName"
],
"properties": {
"index": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"minLength": 1
},
"frags": {
"type": "integer",
"format": "int32"
},
"deaths": {
"type": "integer",
"format": "int32"
},
"teamName": {
"type": "string",
"minLength": 1
}
}
},
"CommunityStatus": {
"type": "object",
"additionalProperties": false,
"properties": {
"communityAppName": {
"type": "string",
"nullable": true
},
"communityAppUri": {
"type": "string",
"nullable": true
}
}
},
"VersionInfo": {
"type": "object",
"additionalProperties": false,
"required": [
"appName",
"version",
"installerUri",
"branchName"
],
"properties": {
"appName": {
"type": "string",
"minLength": 1
},
"version": {
"$ref": "#/components/schemas/AppVersion"
},
"installerUri": {
"type": "string",
"format": "uri",
"minLength": 1
},
"branchName": {
"type": "string",
"minLength": 1
}
}
},
"VersionInfoUpdate": {
"type": "object",
"additionalProperties": false,
"properties": {
"appName": {
"type": "string",
"nullable": true
},
"appVersion": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AppVersion"
}
]
},
"fileName": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"forceUpdate": {
"type": "boolean"
}
}
}
}
}
}