Web Drones Logo
API docs by Redocly

Web Drones (0.0.1)

Download OpenAPI specification:

Api to play Web Drones!

Log In

Log in with username and password.

Authorizations:
basicAuth

Responses

Response samples

Content type
text/plain
Login Successful

Create New User

Creates new user with associated password

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "bots": [
    ],
  • "mines": [
    ]
}

Initialize game

initialize the game with mining locations and a single bot

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
{
  • "bots": [
    ],
  • "mines": [
    ]
}

Get all bot info

Get an array of bots and what they're doing

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get single bot info

Get a single bot by id

Authorizations:
cookieAuth
path Parameters
botId
required
string

Responses

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "status": "IDLE",
  • "coordinates": {
    },
  • "inventory": 0
}

Move a single bot

Move bot to new location

Authorizations:
cookieAuth
path Parameters
botId
required
string
Request Body schema: application/json
required
x
required
number <double>
y
required
number <double>

Responses

Request samples

Content type
application/json
{
  • "x": 0.1,
  • "y": 0.1
}

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "status": "IDLE",
  • "coordinates": {
    },
  • "inventory": 0
}

Extract scrap

Extract scrap from a metal mine near bot's current location. Only works when bot is near a mine.

Authorizations:
cookieAuth
path Parameters
botId
required
string

Responses

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "status": "IDLE",
  • "coordinates": {
    },
  • "inventory": 0
}

Make a new bot

Make a new bot from scrap metal. A bot must have 3 scrap in their inventory to do this.

Authorizations:
cookieAuth
path Parameters
botId
required
string
Request Body schema: application/json
required
NewBotName
required
string

Responses

Request samples

Content type
application/json
{
  • "NewBotName": "string"
}

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "status": "IDLE",
  • "coordinates": {
    },
  • "inventory": 0
}

Get mines

Get the coordinates of mines

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]