docs(estimatedSchedule): add /schedule endpoint docs
This commit is contained in:
@@ -92,6 +92,7 @@
|
|||||||
- [GET Producer Animes](#get-producer-animes)
|
- [GET Producer Animes](#get-producer-animes)
|
||||||
- [GET Genre Animes](#get-genre-animes)
|
- [GET Genre Animes](#get-genre-animes)
|
||||||
- [GET Category Anime](#get-category-anime)
|
- [GET Category Anime](#get-category-anime)
|
||||||
|
- [GET Estimated Schedules](#get-estimated-schedules)
|
||||||
- [GET Anime Episodes](#get-anime-episodes)
|
- [GET Anime Episodes](#get-anime-episodes)
|
||||||
- [GET Anime Episode Servers](#get-anime-episode-servers)
|
- [GET Anime Episode Servers](#get-anime-episode-servers)
|
||||||
- [GET Anime Episode Streaming Links](#get-anime-episode-streaming-links)
|
- [GET Anime Episode Streaming Links](#get-anime-episode-streaming-links)
|
||||||
@@ -705,6 +706,46 @@ console.log(data);
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### `GET` Estimated Schedules
|
||||||
|
|
||||||
|
#### Endpoint
|
||||||
|
|
||||||
|
```sh
|
||||||
|
https://api-aniwatch.onrender.com/anime/schedule?date={date}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Query Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Description | Required? | Default |
|
||||||
|
| :-----------------: | :----: | :------------------------------------------------------------------: | :-------: | :-----: |
|
||||||
|
| `date (yyyy-mm-dd)` | string | The date of the desired schedule. (months & days must have 2 digits) | Yes | -- |
|
||||||
|
|
||||||
|
#### Request sample
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const resp = await fetch(
|
||||||
|
"https://api-aniwatch.onrender.com/anime/schedule?date=2023-01-14"
|
||||||
|
);
|
||||||
|
const data = await resp.json();
|
||||||
|
console.log(data);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Response Schema
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
{
|
||||||
|
scheduledAnimes: [
|
||||||
|
{
|
||||||
|
id: string,
|
||||||
|
time: string, // 24 hours format
|
||||||
|
name: string,
|
||||||
|
jname: string,
|
||||||
|
},
|
||||||
|
{...}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### `GET` Anime Episodes
|
### `GET` Anime Episodes
|
||||||
|
|
||||||
#### Endpoint
|
#### Endpoint
|
||||||
|
|||||||
Reference in New Issue
Block a user