Skip to content

Api

Jump to bottom
Intrpt edited this page Apr 28, 2024 · 13 revisions

API Documentation

API Endpoints

Game Endpoints

Upload game

POST /games/
Parameters
name type data type description
Request Body

Request body is a file

Responses
http code content-type response header response body
201 text/plain;charset=UTF-8 content-location: /games/{uuid}
400 application/json {"message":"{reason}"}
405 application/json {"message":"Method not allowed"}
409 application/json {"message":"Game is already existing"}
500 application/json {"message":"{reason}"}
504 application/json {"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:"[{"uuid":"16ae9a94-bbdc-4310-bf9c-36ea98c11fc9","name":"example"}]
405 text/html;charset=utf-8 {"message":"Method not allowed"}
500 application/json {"message":"Internal Server Error"}
504 application/json {"message":"Kubernetes Control Server not reachable"}
Example cURL

tbd

Get the status of a game

GET /games/{id}/
Parameters
name type data type description
id required string uuid of the game
Responses
http code content-type response header response body
200 application/json {"uuid":"16ae9a94-bbdc-4310-bf9c-36ea98c11fc9","name":"example","status":"installing","url":"https://example.com"}
405 application/json {"message":"Method not allowed"}
404 application/json {"message":"Game not found"}
500 application/json {"message":"{reason}"}
504 application/json {"message":"Kubernetes Control Server not reachable"}
Example cURL

tbd

Delete a game

DELETE /games/{id}/
Parameters
name type data type description
id required string uuid of the game
Responses
http code content-type response header response body
204 text/html;charset=utf-8
405 application/json "message":"Method not allowed"}
404 application/json {"message":"Game not found"}
500 application/json {"message":"{reason}"}
504 application/json {"message":"Kubernetes Control Server not reachable"}
Example cURL

tbd

Clone this wiki locally