From b2c5bc95b04fea317d6804c720973705fd9a60c0 Mon Sep 17 00:00:00 2001 From: CasVT Date: Fri, 28 Jul 2023 15:13:45 +0000 Subject: [PATCH] Updated API docs --- docs/api.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/api.md b/docs/api.md index 5425e8b..1cc2bd5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -195,6 +195,28 @@ The following is automatically generated. Please report any issues on [GitHub](h | ---- | ----- | ----------- | | 200| N/A | Success | +### `/notificationservices/test` + +| Requires being logged in | Description | +| ------------------------ | ----------- | +| Yes | Send a test notification using the supplied Apprise URL | + +??? POST + + **Parameters (body)** + + | Name | Required | Description | Allowed values | + | ---- | -------- | ----------- | -------------- | + | url | Yes | The Apprise URL of the notification service | N/A | + + **Returns** + + | Code | Error | Description | + | ---- | ----- | ----------- | + | 201| N/A | Success | + | 400 | InvalidKeyValue | The value of a key is invalid | + | 400 | KeyNotFound | A key was not found in the input that is required to be given | + ### `/notificationservices/` | Requires being logged in | Description |