Skip to content

Commit d9868f5

Browse files
authored
Merge pull request #13 from AiriAPI/staging
Staging
2 parents a52745b + efcc332 commit d9868f5

File tree

3 files changed

+4
-43
lines changed

3 files changed

+4
-43
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"private": true,
33
"name": "airi_docs",
4-
"version": "1.2.6",
4+
"version": "1.3.6",
55
"description": "Documentatin for a API Serving Anime stuff",
66
"author": "Kyoyo",
77
"license": "AGPLv3",

src/API Packages/javascript.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@
44

55
- `npm i anime-facts` [package link](https://www.npmjs.com/package/anime-facts) _**works for Anime Fact endpoint only**_
66

7-
- `npm i ani-quote` [package link](https://www.npmjs.com/package/random-anime-quotes) _**works for Anime Quote endpoint only**_
7+
- `npm i random-anime-quotes` [package link](https://www.npmjs.com/package/random-anime-quotes) _**works for Anime Quote endpoint only**_
8+
9+
- `npm i ariapi.js` [package link](https://www.npmjs.com/package/ariapi.js) _**works for all endpoints**_

src/Endpoints/fact.md

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -55,47 +55,6 @@ Random fact with tags "AttackonTitan" **`OR`** "Levi" [try in browser](https://a
5555
GET /fact?tags=AttackonTitan|Levi
5656
```
5757

58-
### List facts
59-
60-
Get a paginated list of all facts. This method supports several filter and sorting options.
61-
62-
#### Path
63-
64-
```HTTP
65-
GET /facts
66-
```
67-
68-
#### Query parameters
69-
70-
| param | type | Description |
71-
| :---- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
72-
| limit | `Int` | `Min: 1` `Max: 100` `Default: 20` <br> The number of facts to return per request. (for pagination). |
73-
| skip | `Int` | `Min: 0` `Default: 0` <br> The number of items to skip (for pagination). |
74-
| 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. |
75-
76-
#### Response
77-
78-
```ts
79-
{
80-
// The index of the last fact returned. When paginating through results,
81-
// this value would be used as the `skip` parameter when requesting the next
82-
// "page" of results.
83-
lastIndex: number
84-
// The number of facts returned by this request
85-
resultsCount: number
86-
// The total number of facts matching this request
87-
totalCount: number
88-
// The array of facts
89-
results: Array<{
90-
_id: string
91-
// The fact value in text
92-
fact: string
93-
// An array of tag names for this fact
94-
tags: string[]
95-
}>
96-
}
97-
```
98-
9958
### Get fact By ID
10059

10160
Get a fact by its ID

0 commit comments

Comments
 (0)