From cb113cb38a4912c78b8ee1d96a20061759081de0 Mon Sep 17 00:00:00 2001 From: Ritesh Ghosh Date: Sun, 14 Jul 2024 00:07:17 +0530 Subject: [PATCH] docs: minimize APi docs by using the method present in #56 --- README.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d69f8ad..d770a8e 100644 --- a/README.md +++ b/README.md @@ -152,10 +152,12 @@ The endpoints exposed by the api are listed below with examples that uses the [F
-Get Anime Home Page + ### `GET` Anime Home Page + + #### Endpoint ```bash @@ -266,10 +268,12 @@ console.log(data);
-Get Anime About Info + ### `GET` Anime About Info + + #### Endpoint ```sh @@ -410,10 +414,12 @@ console.log(data);
-Get Anime Search Results + ### `GET` Search Results + + #### Endpoint ```sh @@ -513,10 +519,12 @@ console.log(data);
-Get Anime Search Suggestions + ### `GET` Search Suggestions + + #### Endpoint ```sh @@ -562,10 +570,12 @@ console.log(data);
-Get Producer Animes + ### `GET` Producer Animes + + #### Endpoint ```sh @@ -657,10 +667,12 @@ console.log(data);
-Get Genre Animes + ### `GET` Genre Animes + + #### Endpoint ```sh @@ -736,10 +748,12 @@ console.log(data);
-Get Category Anime + ### `GET` Category Anime + + #### Endpoint ```sh @@ -818,10 +832,12 @@ console.log(data);
-Get Estimated Schedules + ### `GET` Estimated Schedules + + #### Endpoint ```sh @@ -854,6 +870,8 @@ console.log(data); time: string, // 24 hours format name: string, jname: string, + airingTimestamp: number, + secondsUntilAiring: number }, {...} ]