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", diff --git a/src/API Packages/javascript.md b/src/API Packages/javascript.md index 8bb53a1..fcda30a 100644 --- a/src/API Packages/javascript.md +++ b/src/API Packages/javascript.md @@ -4,4 +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**_ 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