Updated docs for notifier/service-seadex
Linked build commit: 2622944efe
This commit is contained in:
1 parent
c1b313b226
commit
fac3434b35
2 files changed
+200
-124
No files matched your search
+53
-43
@@ -2,9 +2,24 @@
|
||||
|
||||
Base URL: `https://notifier.gansejunge.com/internal/seadex`
|
||||
|
||||
### `POST /repository/add`
|
||||
### `POST /admin/update/names`
|
||||
|
||||
**Add Repository Subscription**
|
||||
**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**
|
||||
|
||||
| Name | In | Type | Required |
|
||||
|---|---|---|---|
|
||||
@@ -14,10 +29,7 @@ Base URL: `https://notifier.gansejunge.com/internal/seadex`
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "github",
|
||||
"org": "string",
|
||||
"repo": "string",
|
||||
"tag": "string",
|
||||
"anilist_id": 0,
|
||||
"custom_name": "string"
|
||||
}
|
||||
```
|
||||
@@ -25,10 +37,10 @@ Base URL: `https://notifier.gansejunge.com/internal/seadex`
|
||||
**Example:**
|
||||
|
||||
```bash
|
||||
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/add' \
|
||||
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/add' \
|
||||
-H 'X-API-Key: <api_key>' \
|
||||
-H 'Content-Type: application/json' \
|
||||
-d '{"type": "github", "org": "string", "repo": "string", "tag": "string", "custom_name": "string"}'
|
||||
-d '{"anilist_id": 0, "custom_name": "string"}'
|
||||
```
|
||||
|
||||
**Responses:**
|
||||
@@ -51,9 +63,9 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/add' \
|
||||
}
|
||||
```
|
||||
|
||||
### `POST /repository/delete`
|
||||
### `POST /anime/delete`
|
||||
|
||||
**Delete Repository Subscription**
|
||||
**Remove Anime**
|
||||
|
||||
| Name | In | Type | Required |
|
||||
|---|---|---|---|
|
||||
@@ -63,21 +75,17 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/add' \
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "github",
|
||||
"org": "string",
|
||||
"repo": "string",
|
||||
"tag": "string",
|
||||
"custom_name": "string"
|
||||
"anilist_id": 0
|
||||
}
|
||||
```
|
||||
|
||||
**Example:**
|
||||
|
||||
```bash
|
||||
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/delete' \
|
||||
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/anime/delete' \
|
||||
-H 'X-API-Key: <api_key>' \
|
||||
-H 'Content-Type: application/json' \
|
||||
-d '{"type": "github", "org": "string", "repo": "string", "tag": "string", "custom_name": "string"}'
|
||||
-d '{"anilist_id": 0}'
|
||||
```
|
||||
|
||||
**Responses:**
|
||||
@@ -100,9 +108,9 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/delete'
|
||||
}
|
||||
```
|
||||
|
||||
### `GET /repository/list`
|
||||
### `GET /anime/list`
|
||||
|
||||
**List Subscribed Repositories**
|
||||
**List Active And Inactive Anime**
|
||||
|
||||
| Name | In | Type | Required |
|
||||
|---|---|---|---|
|
||||
@@ -111,13 +119,35 @@ curl -X POST 'https://notifier.gansejunge.com/internal/seadex/repository/delete'
|
||||
**Example:**
|
||||
|
||||
```bash
|
||||
curl -X GET 'https://notifier.gansejunge.com/internal/seadex/repository/list' \
|
||||
curl -X GET 'https://notifier.gansejunge.com/internal/seadex/anime/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
|
||||
{
|
||||
@@ -135,37 +165,17 @@ curl -X GET 'https://notifier.gansejunge.com/internal/seadex/repository/list' \
|
||||
}
|
||||
```
|
||||
|
||||
### `POST /update/{repository_type}`
|
||||
### `POST /update`
|
||||
|
||||
**Update Watched Repositories**
|
||||
|
||||
| Name | In | Type | Required |
|
||||
|---|---|---|---|
|
||||
| `repository_type` | path | string | yes |
|
||||
**Check Seadex**
|
||||
|
||||
**Example:**
|
||||
|
||||
```bash
|
||||
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/update/<repository_type>' \
|
||||
curl -X POST 'https://notifier.gansejunge.com/internal/seadex/update' \
|
||||
-H 'X-API-Key: <api_key>'
|
||||
```
|
||||
|
||||
**Responses:**
|
||||
|
||||
- `200`: Successful Response
|
||||
- `422`: Validation Error
|
||||
```json
|
||||
{
|
||||
"detail": [
|
||||
{
|
||||
"loc": [
|
||||
"string"
|
||||
],
|
||||
"msg": "string",
|
||||
"type": "string",
|
||||
"input": null,
|
||||
"ctx": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
Reference in new issue
Block a user