diff options
| author | Ben Morrison <ben@gbmor.dev> | 2020-05-07 03:06:12 -0400 |
|---|---|---|
| committer | Ben Morrison <ben@gbmor.dev> | 2020-05-07 03:06:12 -0400 |
| commit | a2c0ebacd83128a373ab886639b60002c34e2d9f (patch) | |
| tree | 6fe4adc55b20e8c904e91035d264360f9e9dc0ce | |
| parent | 95266218c377f8bf4ae422208a5c872c9e3ac90f (diff) | |
| download | api-a2c0ebacd83128a373ab886639b60002c34e2d9f.tar.gz | |
added info about cached responses and changed display format of planned endpoints
| -rw-r--r-- | README | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/README b/README index f13f03e..7bb5195 100644 --- a/README +++ b/README @@ -1,30 +1,35 @@ :: Informational API for tilde.institute :: -This allows one to request information and stats via HTTP requests. The GET and -HEAD methods are allowed. All others will receive a 405 response. +This allows one to query information and stats via HTTP requests. GET and +HEAD methods are allowed. All others will receive a 405 response. Responses +will be cached for a short period of time (5m?). Subsequent queries in that +time frame will be served from the cache. Not finished. Currently planning: - FMT = /{plain|json} - - Plaintext or JSON formatted responses + / + - Information on endpoints and purpose - $FMT/osversion + /[plain|json] + - Response formats + + /$FMT/osversion - OpenBSD version - $FMT/pkgs + /$FMT/pkgs - Installed packages - $FMT/query + /$FMT/query ?pkg=[a-zA-Z0-9+] - Check if a package is installed. - $FMT/uptime + /$FMT/uptime - Uptime and Load - $FMT/usercount + /$FMT/usercount - Number of registered user accounts - $FMT/users + /$FMT/users - List of users (maybe CSV for plaintext?) and ancillary information |