diff --git a/About.md b/About.md index 87127d7..57336f5 100644 --- a/About.md +++ b/About.md @@ -9,9 +9,9 @@ Technical support questions check [Support](./Support.md). ## Maintainers -| Name | Links | Contact | -| :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------: | -| LucJosin | [Github :icon-link-external:](https://github.com/LucJosin){target="\_blank"} - [Website :icon-link-external:](https://lucasjosino.com){target="\_blank"} | hawapi@lucasjosino.com | +| Name | Links | Contact | +| :------- | :----------------------------------------------------------------------------------------------------------------------------: | :--------------------: | +| LucJosin | [:icon-mark-github:](https://github.com/LucJosin){target="\_blank"} - [:icon-link:](https://lucasjosino.com){target="\_blank"} | hawapi@lucasjosino.com | @@ -112,6 +112,11 @@ SOFTWARE. [Github :icon-link-external:](https://github.com/modelmapper/modelmapper){target="\_blank"} \ [Apache License 2.0 :icon-link-external:](https://github.com/modelmapper/modelmapper/blob/master/LICENSE.txt){target="\_blank"} +==- guava + +[Github :icon-link-external:](https://github.com/google/guava/){target="\_blank"} \ +[Apache License 2.0 :icon-link-external:](https://github.com/google/guava/blob/master/LICENSE){target="\_blank"} + ==- java-json-tools [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 ==- +> Tests + +==- testcontainers + +[Github :icon-link-external:](https://github.com/testcontainers/testcontainers-java){target="\_blank"} \ +[MIT License :icon-link-external:](https://github.com/testcontainers/testcontainers-java/blob/main/LICENSE){target="\_blank"} + +==- junit + +[Github :icon-link-external:](https://github.com/junit-team/junit5){target="\_blank"} \ +[Eclipse Public License 2.0 :icon-link-external:](https://github.com/junit-team/junit5/blob/main/LICENSE.md){target="\_blank"} + +==- + > Website ==- retype (docs) diff --git a/Examples/Actor-By-Character.md b/Examples/Actor-By-Character.md index 64bd198..017e82c 100644 --- a/Examples/Actor-By-Character.md +++ b/Examples/Actor-By-Character.md @@ -7,16 +7,12 @@ icon: square How to request actor from specific character -## Terminal +## HTTP ### Equals -```sh Terminal -curl {{url}}/api/{{api_version}}/actors?character=/api/v1/characters/50fa9f0c-65bc-451f-90a2-8b864a21bef0 -``` +> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?character=/api/v1/characters/ef69d278-76be-478e-a087-c81071cb83c3 ### Like -```sh Terminal -curl {{url}}/api/{{api_version}}/actors?character=*50fa9f0c-65bc-451f-90a2-8b864a21bef0 -``` +> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?character=\*ef69d278-76be-478e-a087-c81071cb83c3 diff --git a/Examples/Episodes-By-Season.md b/Examples/Episodes-By-Season.md index 33d9587..459bc0b 100644 --- a/Examples/Episodes-By-Season.md +++ b/Examples/Episodes-By-Season.md @@ -7,16 +7,12 @@ icon: square How to request all episodes from specific season -## Terminal +## HTTP ### Equals -```sh Terminal -curl {{url}}/api/{{api_version}}/episodes?seasons=/api/v1/seasons/50fa9f0c-65bc-451f-90a2-8b864a21bef0 -``` +[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?season=/api/v1/seasons/3b980ad3-aef8-4663-a7a9-64cb4979500a ### Like -```sh Terminal -curl {{url}}/api/{{api_version}}/episodes?seasons=*50fa9f0c-65bc-451f-90a2-8b864a21bef0 -``` +[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?season=\*3b980ad3-aef8-4663-a7a9-64cb4979500a diff --git a/Guides/Cors.md b/Guides/Cors.md index 145981c..72b541f 100644 --- a/Guides/Cors.md +++ b/Guides/Cors.md @@ -13,7 +13,7 @@ You don’t need to do anything special to use **CORS** with JavaScript in a mod Fetching all [actors](/API/Actors.md) ```js -fetch("{{url}}/{{api_version}}/actors") +fetch("{{url}}/api/{{api_version}}/actors") .then((response) => response.json()) .then((data) => console.log(data)); ``` diff --git a/Guides/Filters.md b/Guides/Filters.md index 58b785d..a040177 100644 --- a/Guides/Filters.md +++ b/Guides/Filters.md @@ -18,9 +18,7 @@ All filters supported by all endpoints Usage Example: -``` -curl {{url}}/api/{{api_version}}/actors?language=en-US&size=10&page=1&sort=first_name,DESC -``` +> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?language=en-US&size=10&page=1&sort=first_name,DESC !!!info Info 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. | NOT_EQUALS | \* | ! | | EQUALS | \* | | -Usage Example: +### Usage Example: -> All characters with **last name `like` Wheeler**, **gender `equals to` 1** and **birth date `greater or equals to` 1967-01-01** +All characters with **last name `like` Wheeler**, **gender `equals to` 1** and **birth date `greater or equals to` 1967-01-01** -``` -curl {{url}}/api/{{api_version}}/characters?last_name=*Wheeler&gender=1&birth_date=>=1967-01-01 -``` +> [!badge variant="primary" text="GET"] /api/{{api_version}}/characters?**last_name=\*Wheeler&gender=1&birth_date=>=1967-01-01** diff --git a/Guides/I18N.md b/Guides/I18N.md index 4032186..f157458 100644 --- a/Guides/I18N.md +++ b/Guides/I18N.md @@ -15,7 +15,6 @@ The response will contain: 'static' and 'dynamic' data. ```json // Root [ - // Static { "uuid": "...", // Static "release_date": "...", // Static @@ -43,17 +42,13 @@ By default, all requests will be set to `en-US`. ## Examples -- English-USA (en-US) +- English-USA `(en-US)` -``` -curl {{url}}/api/{{api_version}}/episodes?language=en-US -``` +[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?**language=en-US** -- Portuguese-Brazillian (pt-BR) +- Portuguese-Brazillian `(pt-BR)` -``` -curl {{url}}/api/{{api_version}}/episodes?language=pt-BR -``` +[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?**language=pt-BR** !!!info Info Only **ONE** language can be defined per request: diff --git a/Guides/Javadoc.md b/Guides/Javadoc.md index 6707c55..a5bd7dc 100644 --- a/Guides/Javadoc.md +++ b/Guides/Javadoc.md @@ -1,4 +1,4 @@ --- icon: repo -redirect: /javadoc/apidocs/ +redirect: /docs/javadoc/apidocs/ --- diff --git a/Guides/Rate-Limiting.md b/Guides/Rate-Limiting.md index 809ae34..f3ac2b1 100644 --- a/Guides/Rate-Limiting.md +++ b/Guides/Rate-Limiting.md @@ -8,11 +8,11 @@ order: 1 Each API plan comes with a requests limiter. Every API call you make costs a request -| Tier | Limits | Price | Auth | Permissions | -| :-------: | :-------: | :----: | :---: | :---------: | -| ANONYMOUS | 4 req/60s | `FREE` | --- | `GET` | -| BASIC | 6 req/60s | `FREE` | `JWT` | `GET` | -| DEV | 8 req/60s | --- | `JWT` | `GET` | +| Tier | Limits | Price | Auth | Permissions | +| :-------: | :--------: | :----: | :---: | :---------: | +| ANONYMOUS | 8 req/60s | `FREE` | --- | `GET` | +| BASIC | 12 req/60s | `FREE` | `JWT` | `GET` | +| DEV | 16 req/60s | --- | `JWT` | `GET` | [!ref Authentication](Authentication.md) diff --git a/SDK's/index.md b/SDK's/index.md index 81d9909..5cf38d1 100644 --- a/SDK's/index.md +++ b/SDK's/index.md @@ -2,11 +2,12 @@ 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) -| Language | Links | Status | Maintainer | -| :--------- | :-------------------------------------------------------: | :----------------------: | :----------------------------------------------------------------------------: | -| JavaScript | [:icon-file-code:](./js-sdk.md) - [:icon-mark-github:][1] | :icon-verified: Official | [LucJosin :icon-link-external:](https://github.com/LucJosin){target="\_blank"} | +| Language | Links | Status | Maintainer | +| :-------------- | :-------------------------------------------------------------------------------: | :----------------------: | :----------------------------------------------------------------------------: | +| 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"} | [1]: {{git_home}}/js-sdk +[2]: https://www.npmjs.com/package/@hawapi/js-sdk diff --git a/_includes/head.html b/_includes/head.html index 95e3dd6..b1a799d 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -20,12 +20,6 @@ pointer-events: none; } - .docs-icon { - height: 1.11em; - width: 1.18em; - vertical-align: -.2em - } - #docs-site-header > div > div.flex.justify-between > div:nth-child(3) > button { display: none; visibility: hidden; diff --git a/index.md b/index.md index fcdb39e..6a2661f 100644 --- a/index.md +++ b/index.md @@ -74,6 +74,18 @@ All this information is available through a RESTful API implemented with [_Java color: rgb(179 0 0/var(--tw-text-opacity)) !important; } + @media (prefers-color-scheme: light) { + .tiles p .title-box { + border: 1px solid rgb(179 0 0); + color: rgb(179 0 0) !important; + } + + .tiles p:hover .title-box { + border: 1px solid rgb(128 128 128/var(--tw-text-opacity)); + color: rgb(128 128 128/var(--tw-text-opacity)) !important; + } + } + @media (max-width: 1500px) { .tiles { grid-template-columns: repeat(3, 0.2fr);