IT-Syndikat
/
ITSynOpen
Archived
13
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

server: update README

This commit is contained in:
Xiretza 2022-08-16 21:25:18 +02:00
parent 096c7ac168
commit 8c2a309887
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
server/README.md
View File

@ -6,11 +6,11 @@ exist:
in the [SpaceAPI directory](https://github.com/SpaceApi/directory)
- `GET status-s.php`: returns `true` if space is open, `false` if closed. Called by discourse theme
and serendipity.
- `GET update.php`: updates the current open status, called by the wood box with two fat buttons
- `POST update.php`: updates the current open status, called by the wood box with two fat buttons
("2fb").
- `POST ping.php`: requests a "spaceping". Called by the
[matrix bot](https://git.it-syndikat.org/IT-Syndikat/its-matrix-bot).
- `GET ping-get.php`: returns `true` if a ping request is pending, then resets the request. Called
- `POST ping-get.php`: returns `true` if a ping request is pending, then resets the request. Called
by 2fb.
All endpoints except for `status[-s].php` require an API key to be passed via the `apikey=` GET