Skip to content

Commit d3e73e4

Browse files
committed
feat: Update docs
- Add `ImgCDN` to `tech-stack#services` - Update scroll style - Add more examples to `rate-limiting` - Add `fr-FR` and `es-ES` to `support`
1 parent 0c2cbf2 commit d3e73e4

4 files changed

Lines changed: 56 additions & 23 deletions

File tree

About.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ See all tools and related liceses: [Third party licenses](#third-party-licenses)
2323

2424
#### API
2525

26-
- Java
27-
- <a href="https://spring.io/" target="_blank">Spring Boot :icon-link-external:</a>
26+
- <a href="https://aws.amazon.com/corretto/" target="_blank">Java (Amazon Corretto) :icon-link-external:</a>
27+
- <a href="https://spring.io/projects/spring-boot" target="_blank">Spring (Boot) :icon-link-external:</a>
2828
- <a href="https://www.postgresql.org/" target="_blank">PostgreSQL :icon-link-external:</a>
2929

3030
#### Website
@@ -35,9 +35,10 @@ See all tools and related liceses: [Third party licenses](#third-party-licenses)
3535

3636
### Services
3737

38-
- <a href="https://github.com/" target="_blank">Github :icon-link-external:</a> - Project source
38+
- <a href="https://github.com/" target="_blank">Github :icon-link-external:</a> - Project source hosting
3939
- <a href="https://koyeb.com/" target="_blank">Koyeb :icon-link-external:</a> - API/Website hosting
40-
- <a href="https://neon.tech/" target="_blank">Neon :icon-link-external:</a> - Database
40+
- <a href="https://neon.tech/" target="_blank">Neon :icon-link-external:</a> - Database hosting
41+
- <a href="https://imgcdn.dev/" target="_blank">ImgCDN :icon-link-external:</a> - Image hosting
4142
- <a href="https://theproject.id/" target="_blank">theproject.id :icon-link-external:</a> - Hub domain.
4243

4344
## Fair Use Policy

Guides/I18N.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ By default, all requests will be set to `en-US`.
3131

3232
## Support
3333

34-
| Scope | en-US | pt-BR |
35-
| :---------- | :---: | :---: |
36-
| Actors | -- | -- |
37-
| Characters | -- | -- |
38-
| Episodes | Yes | Yes |
39-
| Games | Yes | Yes |
40-
| Locations | Yes | Yes |
41-
| Seasons | Yes | Yes |
42-
| Soundtracks | -- | -- |
34+
| Scope | en-US | pt-BR | fr-FR | es-ES |
35+
| :---------- | :---: | :---: | :---: | :---: |
36+
| Actors | -- | -- | -- | -- |
37+
| Characters | -- | -- | -- | -- |
38+
| Episodes | Yes | Yes | Soon | Soon |
39+
| Games | Yes | Yes | Soon | Soon |
40+
| Locations | Yes | Yes | Soon | Soon |
41+
| Seasons | Yes | Yes | Soon | Soon |
42+
| Soundtracks | -- | -- | -- | -- |
4343

4444
## Examples
4545

@@ -49,8 +49,15 @@ By default, all requests will be set to `en-US`.
4949
curl {{url}}/api/{{api_version}}/episodes?language=en-US
5050
```
5151

52-
- Portuguese-Brazillian (pt-Br)
52+
- Portuguese-Brazillian (pt-BR)
5353

5454
```
5555
curl {{url}}/api/{{api_version}}/episodes?language=pt-BR
5656
```
57+
58+
!!!info Info
59+
Only **ONE** language can be defined per request:
60+
61+
[!badge variant="warning" text="INVALID"](): [...]episodes?**language=pt-BR&?language=es-ES** \
62+
[!badge variant="warning" text="INVALID"](): [...]episodes?**language=pt-BR,es-ES**
63+
!!!

Guides/Rate-Limiting.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,25 +31,30 @@ You have complete control over your quota by looking at the the API response hea
3131
```
3232
HTTP/1.1 200
3333
X-Rate-Limit-Remaining: 11
34+
```
3435

35-
...
36-
37-
HTTP/1.1 200
38-
X-Rate-Limit-Remaining: 1
36+
```json
37+
{
38+
"...": "..."
39+
}
3940
```
4041

4142
### Rejected request
4243

4344
```
44-
HTTP/1.1 200
45-
X-Rate-Limit-Remaining: 1
46-
47-
...
48-
4945
HTTP/1.1 429
5046
X-Rate-Limit-Retry-After-Seconds: 583
5147
```
5248

49+
```json
50+
{
51+
"code": 429,
52+
"status": "Too Many Requests",
53+
"method": "GET",
54+
"cause": "You have exhausted your API request quota"
55+
}
56+
```
57+
5358
!!!info Info
5459
The **HawAPI** is Open Source. \
5560
If for some reason you need more/unlimited requests, i encourage you to host you own server/api.

_includes/head.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,24 @@
3030
display: none;
3131
visibility: hidden;
3232
}
33+
34+
p::-moz-selection, a::-moz-selection {
35+
background-color: rgb(179 0 0);
36+
color: white;
37+
}
38+
39+
p::selection, a::selection {
40+
background-color: rgb(179 0 0);
41+
color: white;
42+
}
43+
44+
/* Scroll */
45+
::-webkit-scrollbar {
46+
width: 8px;
47+
background-color: transparent;
48+
}
49+
50+
::-webkit-scrollbar-thumb {
51+
background-color: rgb(179 0 0);
52+
}
3353
</style>

0 commit comments

Comments
 (0)