Skip to content

Commit c9d60fe

Browse files
authored
Update v1.1.0 (#15)
Features - Add new rate limits - Add new licenses Changes - Remove link from js-sdk - Update links from `/sdks/` - Update maintainer links - Replace examples Fixes - Fix wrong javadoc url - Fix url wrong examples - Fix wrong tile color on light mode
1 parent b25df03 commit c9d60fe

File tree

11 files changed

+59
-50
lines changed

11 files changed

+59
-50
lines changed

Diff for: About.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Technical support questions check [Support](./Support.md).
99

1010
## Maintainers
1111

12-
| Name | Links | Contact |
13-
| :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------: |
14-
| LucJosin | [Github :icon-link-external:](https://github.com/LucJosin){target="\_blank"} - [Website :icon-link-external:](https://lucasjosino.com){target="\_blank"} | [email protected] |
12+
| Name | Links | Contact |
13+
| :------- | :----------------------------------------------------------------------------------------------------------------------------: | :--------------------: |
14+
| LucJosin | [:icon-mark-github:](https://github.com/LucJosin){target="\_blank"} - [:icon-link:](https://lucasjosino.com){target="\_blank"} | [email protected] |
1515

1616
<!-- # Contributors -->
1717

@@ -112,6 +112,11 @@ SOFTWARE.
112112
[Github :icon-link-external:](https://github.com/modelmapper/modelmapper){target="\_blank"} \
113113
[Apache License 2.0 :icon-link-external:](https://github.com/modelmapper/modelmapper/blob/master/LICENSE.txt){target="\_blank"}
114114

115+
==- guava
116+
117+
[Github :icon-link-external:](https://github.com/google/guava/){target="\_blank"} \
118+
[Apache License 2.0 :icon-link-external:](https://github.com/google/guava/blob/master/LICENSE){target="\_blank"}
119+
115120
==- java-json-tools
116121

117122
[Github :icon-link-external:](https://github.com/java-json-tools){target="\_blank"} \
@@ -132,6 +137,20 @@ Ref: [java-json-tools/json-tools :icon-link-external:](https://github.com/java-j
132137

133138
==-
134139

140+
> Tests
141+
142+
==- testcontainers
143+
144+
[Github :icon-link-external:](https://github.com/testcontainers/testcontainers-java){target="\_blank"} \
145+
[MIT License :icon-link-external:](https://github.com/testcontainers/testcontainers-java/blob/main/LICENSE){target="\_blank"}
146+
147+
==- junit
148+
149+
[Github :icon-link-external:](https://github.com/junit-team/junit5){target="\_blank"} \
150+
[Eclipse Public License 2.0 :icon-link-external:](https://github.com/junit-team/junit5/blob/main/LICENSE.md){target="\_blank"}
151+
152+
==-
153+
135154
> Website
136155
137156
==- retype (docs)

Diff for: Examples/Actor-By-Character.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,12 @@ icon: square
77

88
How to request actor from specific character
99

10-
## Terminal
10+
## HTTP
1111

1212
### Equals
1313

14-
```sh Terminal
15-
curl {{url}}/api/{{api_version}}/actors?character=/api/v1/characters/50fa9f0c-65bc-451f-90a2-8b864a21bef0
16-
```
14+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?character=/api/v1/characters/ef69d278-76be-478e-a087-c81071cb83c3
1715
1816
### Like
1917

20-
```sh Terminal
21-
curl {{url}}/api/{{api_version}}/actors?character=*50fa9f0c-65bc-451f-90a2-8b864a21bef0
22-
```
18+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?character=\*ef69d278-76be-478e-a087-c81071cb83c3

Diff for: Examples/Episodes-By-Season.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,12 @@ icon: square
77

88
How to request all episodes from specific season
99

10-
## Terminal
10+
## HTTP
1111

1212
### Equals
1313

14-
```sh Terminal
15-
curl {{url}}/api/{{api_version}}/episodes?seasons=/api/v1/seasons/50fa9f0c-65bc-451f-90a2-8b864a21bef0
16-
```
14+
[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?season=/api/v1/seasons/3b980ad3-aef8-4663-a7a9-64cb4979500a
1715

1816
### Like
1917

20-
```sh Terminal
21-
curl {{url}}/api/{{api_version}}/episodes?seasons=*50fa9f0c-65bc-451f-90a2-8b864a21bef0
22-
```
18+
[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?season=\*3b980ad3-aef8-4663-a7a9-64cb4979500a

Diff for: Guides/Cors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You don’t need to do anything special to use **CORS** with JavaScript in a mod
1313
Fetching all [actors](/API/Actors.md)
1414

1515
```js
16-
fetch("{{url}}/{{api_version}}/actors")
16+
fetch("{{url}}/api/{{api_version}}/actors")
1717
.then((response) => response.json())
1818
.then((data) => console.log(data));
1919
```

Diff for: Guides/Filters.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ All filters supported by all endpoints
1818

1919
Usage Example:
2020

21-
```
22-
curl {{url}}/api/{{api_version}}/actors?language=en-US&size=10&page=1&sort=first_name,DESC
23-
```
21+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?language=en-US&size=10&page=1&sort=first_name,DESC
2422
2523
!!!info Info
2624
The `size` option, by default, is set to 10 and **LIMITED** to 20 (Per page).
@@ -57,10 +55,8 @@ The request can be modified/flexible using the modificaton symbols.
5755
| NOT_EQUALS | \* | ! |
5856
| EQUALS | \* | |
5957

60-
Usage Example:
58+
### Usage Example:
6159

62-
> All characters with **last name `like` Wheeler**, **gender `equals to` 1** and **birth date `greater or equals to` 1967-01-01**
60+
All characters with **last name `like` Wheeler**, **gender `equals to` 1** and **birth date `greater or equals to` 1967-01-01**
6361

64-
```
65-
curl {{url}}/api/{{api_version}}/characters?last_name=*Wheeler&gender=1&birth_date=>=1967-01-01
66-
```
62+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/characters?**last_name=\*Wheeler&gender=1&birth_date=>=1967-01-01**

Diff for: Guides/I18N.md

+4-9
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ The response will contain: 'static' and 'dynamic' data.
1515
```json
1616
// Root
1717
[
18-
// Static
1918
{
2019
"uuid": "...", // Static
2120
"release_date": "...", // Static
@@ -43,17 +42,13 @@ By default, all requests will be set to `en-US`.
4342

4443
## Examples
4544

46-
- English-USA (en-US)
45+
- English-USA `(en-US)`
4746

48-
```
49-
curl {{url}}/api/{{api_version}}/episodes?language=en-US
50-
```
47+
[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?**language=en-US**
5148

52-
- Portuguese-Brazillian (pt-BR)
49+
- Portuguese-Brazillian `(pt-BR)`
5350

54-
```
55-
curl {{url}}/api/{{api_version}}/episodes?language=pt-BR
56-
```
51+
[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?**language=pt-BR**
5752

5853
!!!info Info
5954
Only **ONE** language can be defined per request:

Diff for: Guides/Javadoc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
icon: repo
3-
redirect: /javadoc/apidocs/
3+
redirect: /docs/javadoc/apidocs/
44
---

Diff for: Guides/Rate-Limiting.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ order: 1
88

99
Each API plan comes with a requests limiter. Every API call you make costs a request
1010

11-
| Tier | Limits | Price | Auth | Permissions |
12-
| :-------: | :-------: | :----: | :---: | :---------: |
13-
| ANONYMOUS | 4 req/60s | `FREE` | --- | `GET` |
14-
| BASIC | 6 req/60s | `FREE` | `JWT` | `GET` |
15-
| DEV | 8 req/60s | --- | `JWT` | `GET` |
11+
| Tier | Limits | Price | Auth | Permissions |
12+
| :-------: | :--------: | :----: | :---: | :---------: |
13+
| ANONYMOUS | 8 req/60s | `FREE` | --- | `GET` |
14+
| BASIC | 12 req/60s | `FREE` | `JWT` | `GET` |
15+
| DEV | 16 req/60s | --- | `JWT` | `GET` |
1616

1717
[!ref Authentication](Authentication.md)
1818

Diff for: SDK's/index.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
A Software Development Kit (SDK) is a set of tools provided by the manufacturer of (usually) a hardware platform, operating system (OS), or programming language. [\[\*\]](https://www.redhat.com/en/topics/cloud-native-apps/what-is-SDK)
44

5-
| Language | Links | Status | Maintainer |
6-
| :--------- | :-------------------------------------------------------: | :----------------------: | :----------------------------------------------------------------------------: |
7-
| JavaScript | [:icon-file-code:](./js-sdk.md) - [:icon-mark-github:][1] | :icon-verified: Official | [LucJosin :icon-link-external:](https://github.com/LucJosin){target="\_blank"} |
5+
| Language | Links | Status | Maintainer |
6+
| :-------------- | :-------------------------------------------------------------------------------: | :----------------------: | :----------------------------------------------------------------------------: |
7+
| Java/TypeScript | [:icon-mark-github:][1]{target="\_blank"} - [:icon-package:][2]{target="\_blank"} | :icon-verified: Official | [LucJosin :icon-link-external:](https://github.com/LucJosin){target="\_blank"} |
88

99
[1]: {{git_home}}/js-sdk
10+
[2]: https://www.npmjs.com/package/@hawapi/js-sdk
1011

1112
<!-- | Java | [:icon-file-code:](./java-sdk.md) - [:icon-mark-github:][2] | :icon-verified: Official | [LucJosin](https://github.com/LucJosin) | -->
1213
<!-- [2]: {{git_home}}/java-sdk -->

Diff for: _includes/head.html

-6
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@
2020
pointer-events: none;
2121
}
2222

23-
.docs-icon {
24-
height: 1.11em;
25-
width: 1.18em;
26-
vertical-align: -.2em
27-
}
28-
2923
#docs-site-header > div > div.flex.justify-between > div:nth-child(3) > button {
3024
display: none;
3125
visibility: hidden;

Diff for: index.md

+12
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,18 @@ All this information is available through a RESTful API implemented with [_Java
7474
color: rgb(179 0 0/var(--tw-text-opacity)) !important;
7575
}
7676

77+
@media (prefers-color-scheme: light) {
78+
.tiles p .title-box {
79+
border: 1px solid rgb(179 0 0);
80+
color: rgb(179 0 0) !important;
81+
}
82+
83+
.tiles p:hover .title-box {
84+
border: 1px solid rgb(128 128 128/var(--tw-text-opacity));
85+
color: rgb(128 128 128/var(--tw-text-opacity)) !important;
86+
}
87+
}
88+
7789
@media (max-width: 1500px) {
7890
.tiles {
7991
grid-template-columns: repeat(3, 0.2fr);

0 commit comments

Comments
 (0)