xevion/bus-reminder
1
0
Fork 0
mirror of https://github.com/Xevion/bus-reminder.git synced 2025-12-15 14:11:16 -06:00
Code Issues Packages Projects Releases Wiki Activity

Implement dry run, remove ?force from README

Browse Source
This commit is contained in:
Xevion
2023-09-05 15:31:26 -05:00
parent 77690b37e7
commit 877e48abed
2 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -67,7 +67,6 @@ might be easier (although I require Node APIs, I believe).
- `/api/cron` is the primary cron-job endpoint. Authorization required.
- `?report=true` is assumed, and when `true`, Cronitor will be notified of the job's status.
- `?dry=true` will not send any notifications or effects, but will still perform all checks and logging for runtime testing.
- `?force=true` will skip configuration time checks and send notifications regardless of how long it's been since the last notification.
- `/api/health` is a simple health check endpoint. Authorization optional.
- `/api/check` is a simple endpoint to check authorization.
- `/api/config` is the configuration endpoint. Authorization required.