Api

API Documentation

API Endpoints

Game Endpoints

Upload game

POST /games/{name}/

Parameters

name	type	data type	description
name	required	string	name of the game

Responses

http code	content-type	response header	response body
201	text/plain;charset=UTF-8	content-location: /games/{name}	None
400	application/json		{"code":"400","message":"Bad Request"}
405	text/html;charset=utf-8		{"code":"405","message":"Method not allowed"}
409	application/json		{"code":"409","message":"Game is already existing"}
500	application/json		{"code":"500","message":"Internal Server Error"}
504	application/json		{"code":"504","message":"Kubernetes Control Server not reachable"}

Example cURL

tbd

---

Get all uploaded games

GET /games/

Parameters

name	type	data type	description

Responses

http code	content-type	response header	response body
200	application/json		"games:"[{"name":"example"}]
405	text/html;charset=utf-8		{"code":"405","message":"Method not allowed"}
409	application/json		{"code":"409","message":"Game is already existing"}
500	application/json		{"code":"500","message":"Internal Server Error"}
504	application/json		{"code":"504","message":"Kubernetes Control Server not reachable"}

Example cURL

tbd

---

Get the status of a game

GET /games/{name}/

Parameters

name	type	data type	description
name	required	string	name of the game

Responses

http code	content-type	response header	response body
200	application/json		`{"name":"example","status":"installing","url":"https://example.com"}
405	text/html;charset=utf-8		{"code":"405","message":"Method not allowed"}
404	application/json		{"code":"404","message":"Game not found"}
500	application/json		{"code":"500","message":"Internal Server Error"}
504	application/json		{"code":"504","message":"Kubernetes Control Server not reachable"}

Example cURL

tbd

---

Delete a game

DELETE /games/{name}/

Parameters

name	type	data type	description
name	required	string	name of the game

Responses

http code	content-type	response header	response body
204	application/json		None
405	text/html;charset=utf-8		{"code":"405","message":"Method not allowed"}
404	application/json		{"code":"404","message":"Game not found"}
500	application/json		{"code":"500","message":"Internal Server Error"}
504	application/json		{"code":"504","message":"Kubernetes Control Server not reachable"}

Example cURL

tbd

---