Skip to content

Commit 50834bc

Browse files
committed
πŸ—žοΈ Added new endpoints, fixed some issues and bumped the version
1 parent df12c4e commit 50834bc

File tree

14 files changed

+102
-32
lines changed

14 files changed

+102
-32
lines changed

β€Ždocs/index.mdβ€Ž

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22

33
### Airi API
44

5-
- Version: `1.0.0`
6-
- Base URL: `https://animu.ml/:endpoint`
5+
- Version: `1.0.2`
6+
- Base URL: `https://airi.kyoyo.me/api/:endpoint`
77
- Protocols: `https`
88
- Responds With: `application/json`
99

1010
### API rules
1111

12-
> By using the API service you agree to follow the rules of it and will get punished (if abuse) accordingly depending upon the severity of violation.
12+
> By using the API service you agree to allow us to log your IP for the health of the API, follow the rules of it and will get punished (if abuse) accordingly depending upon the severity of violation.
1313
> All the offence result's permanent ban from using the API
1414
1515
- DDoSing or brute-forcing in any way.
1616
- Mass accounts creation in any way (1 token/person).
1717
- Data scraping.
18-
- Bypassing the rate-limits in any way (15 requests/second). `[TBC]`
19-
- Bypassing the request quote in any way (1000 requests/month). `[TBC]`
18+
- Bypassing the rate-limits in any way (5 requests/second).
2019
- Abusing bugs and not informing to staff in any way.
2120
- Creating flaws in rules and abusing.
2221
> Think it has flaws? Then please let us [know](https://discord.gg/yyW389c). If possible we would change it asap.
@@ -32,12 +31,16 @@
3231

3332
To get your API token, join this [discord server](https://discord.gg/yyW389c), then type `-claim` in [#bot-commands](https://discord.com/channels/479300008118714388/800784815908454452), fill the questions asked by [@Matsumoto](https://discord.com/channels/@me/834416864766591016) in DM, and receive your token.
3433

35-
**How can you help?**
34+
**How can I support the project?**
3635

37-
- Contribute to the [API](https://github.com/AnimuAPI/Animu)
36+
- Contribute to the [API](https://github.com/AiriAPI/Airi)
3837
- Donate me via [Ko-fi](https://ko-fi.com/Kyoyo)
3938
- Give feedback or suggestions in [discord server](https://discord.gg/yyW389c).
4039

4140
**Support for API**
4241

4342
Need help? Worry not! A support server is there to help you on discord: https://discord.gg/yyW389c
43+
44+
**No API wrapper for my language, what I do now?**
45+
46+
If you don't see one for your language, then there's no module exist for your language and you have to do regular fetch requests. However, you can create one, then let me know in our support server, and I will be glad to add it here.

β€Ž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.1.3",
4+
"version": "1.2.3",
55
"description": "Documentatin for a API Serving Anime stuff",
66
"author": "Kyoyo",
77
"license": "AGPLv3",

β€Žsrc/API Packages/index.mdβ€Ž

Lines changed: 0 additions & 10 deletions
This file was deleted.

β€Žsrc/API Packages/index.tsxβ€Ž

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Javascript
2+
3+
---
4+
5+
- `npm i anime-facts` [package link](https://www.npmjs.com/package/anime-facts) _**works for Anime Fact endpoint only**_

β€Žsrc/Authentication/index.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
- Use the API key that you generate to authenticate each request made to the API.
44

5-
> If you don’t have an API Key, then just head over to https://docs-airi.netlify.app, then read and get one for free.
5+
> If you don’t have an API Key, then just head over to https://docs.airi.kyoyo.me/#frequently-asked-questions-faqs, then read and get one for free.
66
77
> **Request Header**
88
>

β€Žsrc/Authentication/index.tsxβ€Ž

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Anime Fact
1+
## Fact
22

33
### Generate random Anime facts
44

β€Žsrc/Endpoints/index.tsxβ€Ž

Lines changed: 0 additions & 3 deletions
This file was deleted.

β€Žsrc/Endpoints/password.mdβ€Ž

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Password
2+
3+
Generates a random password
4+
5+
#### Path
6+
7+
```HTTP
8+
GET /password
9+
```
10+
11+
#### Response
12+
13+
```ts
14+
{
15+
_id: number;
16+
// The random password
17+
pass: string;
18+
}
19+
```

0 commit comments

Comments
Β (0)