From 384449cd8d0c3d93b41ead4a678e0cdcc1eaea69 Mon Sep 17 00:00:00 2001 From: Unknown Date: Sat, 18 Sep 2021 20:16:21 -0400 Subject: [PATCH 1/4] Add AriAPI.js to JavaScript packages --- src/API Packages/javascript.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/API Packages/javascript.md b/src/API Packages/javascript.md index 8bb53a1..007654c 100644 --- a/src/API Packages/javascript.md +++ b/src/API Packages/javascript.md @@ -5,3 +5,5 @@ - `npm i anime-facts` [package link](https://www.npmjs.com/package/anime-facts) _**works for Anime Fact endpoint only**_ - `npm i ani-quote` [package link](https://www.npmjs.com/package/random-anime-quotes) _**works for Anime Quote endpoint only**_ + +- `npm i ariapi.js` [package link](https://www.npmjs.com/package/ariapi.js) _**works for all endpoints**_ From 4968a08091c4aa87dc2b61d436259fd92ecec705 Mon Sep 17 00:00:00 2001 From: Kyoyo Date: Mon, 20 Sep 2021 05:11:18 +0530 Subject: [PATCH 2/4] Removed GET /facts --- src/Endpoints/fact.md | 41 ----------------------------------------- 1 file changed, 41 deletions(-) diff --git a/src/Endpoints/fact.md b/src/Endpoints/fact.md index ee6d1e7..f817fdc 100644 --- a/src/Endpoints/fact.md +++ b/src/Endpoints/fact.md @@ -55,47 +55,6 @@ Random fact with tags "AttackonTitan" **`OR`** "Levi" [try in browser](https://a GET /fact?tags=AttackonTitan|Levi ``` -### List facts - -Get a paginated list of all facts. This method supports several filter and sorting options. - -#### Path - -```HTTP -GET /facts -``` - -#### Query parameters - -| param | type | Description | -| :---- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| limit | `Int` | `Min: 1` `Max: 100` `Default: 20`
The number of facts to return per request. (for pagination). | -| skip | `Int` | `Min: 0` `Default: 0`
The number of items to skip (for pagination). | -| tags | `String` | Filter facts by tag(s). Takes a list of one or more tag names, separated by a comma (meaning `AND`) or a pipe (meaning `OR`). A comma separated list will match facts that have **_all_** of the given tags. While a pipe (`\|`) separated list will match facts that have **_either_** of the provided tags. | - -#### Response - -```ts -{ - // The index of the last fact returned. When paginating through results, - // this value would be used as the `skip` parameter when requesting the next - // "page" of results. - lastIndex: number - // The number of facts returned by this request - resultsCount: number - // The total number of facts matching this request - totalCount: number - // The array of facts - results: Array<{ - _id: string - // The fact value in text - fact: string - // An array of tag names for this fact - tags: string[] - }> -} -``` - ### Get fact By ID Get a fact by its ID From 11ca8753e94cda923a1dad260d91e0ec1f784d52 Mon Sep 17 00:00:00 2001 From: Kyoyo Date: Mon, 20 Sep 2021 05:11:42 +0530 Subject: [PATCH 3/4] Updated quotes npm package --- src/API Packages/javascript.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/API Packages/javascript.md b/src/API Packages/javascript.md index 007654c..fcda30a 100644 --- a/src/API Packages/javascript.md +++ b/src/API Packages/javascript.md @@ -4,6 +4,6 @@ - `npm i anime-facts` [package link](https://www.npmjs.com/package/anime-facts) _**works for Anime Fact endpoint only**_ -- `npm i ani-quote` [package link](https://www.npmjs.com/package/random-anime-quotes) _**works for Anime Quote endpoint only**_ +- `npm i random-anime-quotes` [package link](https://www.npmjs.com/package/random-anime-quotes) _**works for Anime Quote endpoint only**_ - `npm i ariapi.js` [package link](https://www.npmjs.com/package/ariapi.js) _**works for all endpoints**_ From efcc332a4f15ab6fc440fec252a0bb99627e5003 Mon Sep 17 00:00:00 2001 From: Kyoyo Date: Mon, 20 Sep 2021 05:11:54 +0530 Subject: [PATCH 4/4] Bumped the version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 83e90f6..802db8a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "airi_docs", - "version": "1.2.6", + "version": "1.3.6", "description": "Documentatin for a API Serving Anime stuff", "author": "Kyoyo", "license": "AGPLv3",