From 02a0798a7e7262620baaaa76bc51338bbff22f90 Mon Sep 17 00:00:00 2001 From: Katalina Okano Date: Sat, 26 Nov 2022 21:55:17 -0500 Subject: [PATCH] remove api reference from README --- README.md | 48 ------------------------------------------------ 1 file changed, 48 deletions(-) diff --git a/README.md b/README.md index a3e205c..eb02906 100644 --- a/README.md +++ b/README.md @@ -14,54 +14,6 @@ Please open an issue here or get in touch with Pomf (okano#0001) on the PS2 Disc The main use case is for [Medkit](https://github.com/kayteh/medkit2) bot to have an in-house source of population data, without relying too heavily on any third-party stats service, like Fisu, Honu, or Voidwell; which all have different population tracking needs and goals (and thus, different data.) -## API Reference - -This API will never return a failure unless the app itself is failing. If you request a world ID that doesn't exist, it only sees an empty set, and will not 404. Since 0 can both mean a server is down and it doesn't exist, be mindful of the data. It could even mean the Websockets have failed. - -This API only supports GET, and supports CORS. - -- [`/`](https://saerro.harasse.rs) - Shows a help/usage message. -- [`/w/{worldID}`](https://saerro.harasse.rs) - Shows a help/usage message. - - ```json - { - "worldID": 17, - "total": 1000, - "factions": { - "tr": 334, - "nc": 333, - "vs": 333 - } - } - ``` - -- [`/m/?id={worldID1},{worldID2}...`](https://saerro.harasse.rs/m/?id=1,17) - Shows populations for all listed worlds, example: - - ```json - { - "worlds": [ - { - "worldID": 17, - "total": 1000, - "factions": { - "tr": 334, - "nc": 333, - "vs": 333 - } - }, - { - "worldID": 19, - "total": 1000, - "factions": { - "tr": 334, - "nc": 333, - "vs": 333 - } - } - ] - } - ``` - ## Architecture - Websocket processors