Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 3 additions & 1 deletion src/API Packages/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
41 changes: 0 additions & 41 deletions src/Endpoints/fact.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` <br> The number of facts to return per request. (for pagination). |
| skip | `Int` | `Min: 0` `Default: 0` <br> 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
Expand Down