Updated docs for notifier/backend-pull-notifications
Linked build commit: c4a5e07344
This commit is contained in:
1 parent
8a1c62fa83
commit
54eea87ffd
2 files changed
+191
No files matched your search
@@ -0,0 +1,47 @@
|
||||
# backend-pull-notifications
|
||||
|
||||
Base URL: `https://notifier.gansejunge.com/internal/backend-pull-notifications`
|
||||
|
||||
### `POST /notifications/pull`
|
||||
|
||||
**Pull Notifications**
|
||||
|
||||
| Name | In | Type | Required |
|
||||
|---|---|---|---|
|
||||
| `X-User-Id` | header | integer | yes |
|
||||
|
||||
**Example:**
|
||||
|
||||
```bash
|
||||
curl -X POST 'https://notifier.gansejunge.com/internal/backend-pull-notifications/notifications/pull' \
|
||||
-H 'X-API-Key: <api_key>'
|
||||
```
|
||||
|
||||
**Responses:**
|
||||
|
||||
- `200`: Successful Response
|
||||
```json
|
||||
{
|
||||
"messages": [
|
||||
{}
|
||||
],
|
||||
"count": 0,
|
||||
"has_more": true
|
||||
}
|
||||
```
|
||||
- `422`: Validation Error
|
||||
```json
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": [
|
||||
"string"
|
||||
],
|
||||
"msg": "string",
|
||||
"type": "string",
|
||||
"input": null,
|
||||
"ctx": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
Reference in new issue
Block a user