Improved the Open API specification document (#19)

This PR contains the work done to improve the `OpenAPI` specification documentation that describes the `Amiibo API` online service as well as updates to the `AmiiboLiveClient` that uses the code generated out of the mentioned document. In addition, some test cases have been updated to reflect the latest data in the service.

Reviewed-on: #19
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #19.
This commit is contained in:
2025-10-14 23:26:42 +00:00
committed by Javier Cicchelli
parent 34627840db
commit 4623c13c24
123 changed files with 561 additions and 394 deletions
@@ -0,0 +1,18 @@
# ``AmiiboClient``
## Topics
### Amiibo endpoints
- ``AmiiboClient/getAmiibos(by:)``
- ``AmiiboClient/getAmiiboSeries(by:)``
- ``AmiiboClient/getAmiiboTypes(by:)``
### Game endpoints
- ``AmiiboClient/getGameCharacters(by:)``
- ``AmiiboClient/getGameSeries(by:)``
### System endpoints
- ``AmiiboClient/getLastUpdated()``
@@ -0,0 +1,22 @@
# ``AmiiboLiveClient``
## Topics
### Initializers
- ``AmiiboLiveClient/init(transport:)``
### Amiibo endpoints
- ``AmiiboLiveClient/getAmiibos(by:)``
- ``AmiiboLiveClient/getAmiiboSeries(by:)``
- ``AmiiboLiveClient/getAmiiboTypes(by:)``
### Game endpoints
- ``AmiiboLiveClient/getGameCharacters(by:)``
- ``AmiiboLiveClient/getGameSeries(by:)``
### System endpoints
- ``AmiiboLiveClient/getLastUpdated()``
@@ -18,7 +18,7 @@ To use the `AmiiboService` library with your package, then add it as a dependenc
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/rock-n-code/amiibo-service", from: "1.1.0"),
.package(url: "https://github.com/rock-n-code/amiibo-service", from: "1.2.0"),
// other dependencies
],
targets: [
@@ -58,7 +58,7 @@ $ make
- ``AmiiboClient``
- ``AmiiboLiveClient``
### Types
### Models
- ``Amiibo``
- ``Amiibo/Game``