nolint:govet // there is too much issues with incompatible struct tags.

GetHealth godoc @Summary Retrieves the status of the server and game loop @Description Retrieves the status of the server and game loop @Produce application/json @Success 200 {object} GetHealthResponse "Server and game loop status" @Router /health [get].

GetReceipts godoc @Summary Retrieves all transaction receipts @Description Retrieves all transaction receipts @Accept application/json @Produce application/json @Param ListTxReceiptsRequest body ListTxReceiptsRequest true "Query body" @Success 200 {object} ListTxReceiptsResponse "List of receipts" @Failure 400 {string} string "Invalid request body" @Router /query/receipts/list [post].

GetState godoc @Summary Retrieves a list of all entities in the game state @Description Retrieves a list of all entities in the game state @Produce application/json @Success 200 {object} DebugStateResponse "List of all entities" @Router /debug/state [post].

GetWorld godoc @Summary Retrieves details of the game world @Description Contains the registered components, messages, queries, and namespace @Accept application/json @Produce application/json @Success 200 {object} GetWorldResponse "Details of the game world" @Failure 400 {string} string "Invalid request parameters" @Router /world [get].

PostCQL godoc @Summary Executes a CQL (Cardinal Query Language) query @Description Executes a CQL (Cardinal Query Language) query @Accept application/json @Produce application/json @Param cql body CQLQueryRequest true "CQL query to be executed" @Success 200 {object} CQLQueryResponse "Results of the executed CQL query" @Failure 400 {string} string "Invalid request parameters" @Router /cql [post].

NOTE: duplication for cleaner swagger docs PostTransaction godoc @Summary Submits a transaction @Description Submits a transaction @Accept application/json @Produce application/json @Param txName path string true "Name of a registered message" @Param txBody body Transaction true "Transaction details & message to be submitted" @Success 200 {object} PostTransactionResponse "Transaction hash and tick" @Failure 400 {string} string "Invalid request parameter" @Failure 403 {string} string "Forbidden" @Failure 408 {string} string "Request Timeout - message expired" @Router /tx/game/{txName} [post].

NOTE: duplication for cleaner swagger docs PostTransaction godoc @Summary Creates a persona @Description Creates a persona @Accept application/json @Produce application/json @Param txBody body Transaction true "Transaction details & message to be submitted" @Success 200 {object} PostTransactionResponse "Transaction hash and tick" @Failure 400 {string} string "Invalid request parameter" @Failure 401 {string} string "Unauthorized - signature was invalid" @Failure 403 {string} string "Forbidden" @Failure 408 {string} string "Request Timeout - message expired" @Failure 500 {string} string "Internal Server Error - unexpected cache errors" @Router /tx/persona/create-persona [post].

PostQuery godoc @Summary Executes a query @Description Executes a query @Accept application/json @Produce application/json @Param queryGroup path string true "Query group" @Param queryName path string true "Name of a registered query" @Param queryBody body object true "Query to be executed" @Success 200 {object} object "Results of the executed query" @Failure 400 {string} string "Invalid request parameters" @Router /query/{queryGroup}/{queryName} [post].

PostTransaction godoc @Summary Submits a transaction @Description Submits a transaction @Accept application/json @Produce application/json @Param txGroup path string true "Message group" @Param txName path string true "Name of a registered message" @Param txBody body Transaction true "Transaction details & message to be submitted" @Success 200 {object} PostTransactionResponse "Transaction hash and tick" @Failure 400 {string} string "Invalid request parameter" @Failure 403 {string} string "Forbidden" @Failure 408 {string} string "Request Timeout - message expired" @Router /tx/{txGroup}/{txName} [post].

WebSocketEvents godoc @Summary Establishes a new websocket connection to retrieve system events @Description Establishes a new websocket connection to retrieve system events @Produce application/json @Success 101 {string} string "Switch protocol to ws" @Router /events [get].

GetWorldResponse is a type representing the json super structure that contains all info about the world.

ListTxReceiptsResponse returns the transaction receipts for the given range of ticks.

PostTransactionResponse is the HTTP response for a successful transaction submission.

ReceiptEntry represents a single transaction receipt.