Updated docs for notifier/service-docker-repository-query

Linked build commit: 39736e8da3
This commit is contained in:
automation-bot committed 2026-11-06 15:47:37 +00:00
1 parent 54eea87ffd
commit 176f99dc14
2 files changed
+124 -200

No files matched your search

+43 -53
View File
@@ -2,24 +2,9 @@
Base URL: `https://notifier.gansejunge.com/internal/seadex`
### `POST /admin/update/names`
### `POST /repository/add`
**Update All Names To Most Recently Available**
**Example:**
```bash
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/admin/update/names' \
-H 'X-API-Key: <api_key>'
```
**Responses:**
- `200`: Successful Response
### `POST /anime/add`
**Add Anime**
**Add Repository Subscription**
| Name | In | Type | Required |
|---|---|---|---|
@@ -29,7 +14,10 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/admin/update/names
```json
{
"anilist_id": 0,
"type": "github",
"org": "string",
"repo": "string",
"tag": "string",
"custom_name": "string"
}
```
@@ -37,10 +25,10 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/admin/update/names
**Example:**
```bash
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/add' \
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/add' \
-H 'X-API-Key: <api_key>' \
-H 'Content-Type: application/json' \
-d '{"anilist_id": 0, "custom_name": "string"}'
-d '{"type": "github", "org": "string", "repo": "string", "tag": "string", "custom_name": "string"}'
```
**Responses:**
@@ -63,9 +51,9 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/add' \
}
```
### `POST /anime/delete`
### `POST /repository/delete`
**Remove Anime**
**Delete Repository Subscription**
| Name | In | Type | Required |
|---|---|---|---|
@@ -75,17 +63,21 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/add' \
```json
{
"anilist_id": 0
"type": "github",
"org": "string",
"repo": "string",
"tag": "string",
"custom_name": "string"
}
```
**Example:**
```bash
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/delete' \
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/delete' \
-H 'X-API-Key: <api_key>' \
-H 'Content-Type: application/json' \
-d '{"anilist_id": 0}'
-d '{"type": "github", "org": "string", "repo": "string", "tag": "string", "custom_name": "string"}'
```
**Responses:**
@@ -108,9 +100,9 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/delete' \
}
```
### `GET /anime/list`
### `GET /repository/list`
**List Active And Inactive Anime**
**List Subscribed Repositories**
| Name | In | Type | Required |
|---|---|---|---|
@@ -119,35 +111,13 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/delete' \
**Example:**
```bash
curl -X GET 'https://notifier.gansejunge.com/internal/seadex/anime/list' \
curl -X GET 'https://notifier.gansejunge.com/internal/seadex/repository/list' \
-H 'X-API-Key: <api_key>'
```
**Responses:**
- `200`: Successful Response
```json
{
"active": [
{
"name": "string",
"anilist_id": 0,
"last_updated": "string"
}
],
"inactive": [
{
"name": "string",
"anilist_id": 0,
"last_updated": "string"
}
],
"counts": {
"active": 0,
"inactive": 0
}
}
```
- `422`: Validation Error
```json
{
@@ -165,17 +135,37 @@ curl -X GET 'https://notifier.gansejunge.com/internal/seadex/anime/list' \
}
```
### `POST /update`
### `POST /update/{repository_type}`
**Check Seadex**
**Update Watched Repositories**
| Name | In | Type | Required |
|---|---|---|---|
| `repository_type` | path | string | yes |
**Example:**
```bash
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/update' \
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/update/<repository_type>' \
-H 'X-API-Key: <api_key>'
```
**Responses:**
- `200`: Successful Response
- `422`: Validation Error
```json
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}
```