RT API game data documentation?

OGS Development API Development
1

Several sections of the Real-Time API docs refer to full documentation of the game data object at The game object, but that page is empty. Is there another place this data exists? Is it expected to be the same format as when you fetch a game via the REST API?

Thanks!

1 Like
2

Those docs are really out of date. Curious where did you find them? I just removed one reference (README: link to the newer Real Time API docs by benjaminpjones · Pull Request #3196 · online-go/online-go.com · GitHub) and it would be great if we could remove others.

Newer docs here: protocol | goban

Is it expected to be the same format as when you fetch a game via the REST API?

I don’t know for sure, but IME the results for websocket vs REST are similar but not identical. Best way is to examine the result.

3

I believe the closest socket equivalent to GET /api/v1/games/{id} is game/:id/gamedata, which emits a GobanEngineConfig.

4

Thanks! I think I found that via Googling around, both leading directly to that page and via OGS API notes.

Do you know if there’s a place that provides actual notes on the wire protocol? Those generated docs for the goban library aren’t particularly useful for e.g. seeing what messages are emitted by the socket object or can be sent by a client. I’m sure if I need to I can manually work my way through the goban code to understand the flow of e.g. playing a game in real-time, but I’d expect the RT API to have actual documentation about which commands exist and flow in which directions.

1 Like
5

Okay, cool found the ClientToServer and ServerToClient pages, still a bit barebones but at least this is mostly what I was looking for.

Worth noting that protocol | goban looks like it intends to link to those pages (it contains the strings “[[ClientToServer]]” and “[[ServerToClient]]” in its explanation, those look like they’re intended to be linkified by the docs generator), but they are not actually valid links.

1 Like
6

If you find better ones, let me know :sweat_smile: I don’t find the API to be well documented, and the most efficient way has been to navigate the main website with the network panel open.