8 Commits

Author SHA1 Message Date
9a157d0569 [Improvement] Amiibo DTO (#21)
This PR contains the work done to improve the `DTO.Amiibo` model, especially with regards on how it renders its image URL. Given this change has a direct impact on the project documentation, both Xcode and Web documentations have been regenerated.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #21
2023-07-25 07:49:22 +00:00
629aaf10a0 [Improvement] Codable models (#20)
This PR contains the work done to make all the public models to conform to the `Codable` protocol. Of course, this work required the Xcode and the Web documentations to be regenerated.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #20
2023-07-23 14:40:24 +00:00
f0c22f2747 [Improvement] DTOs (#19)
This PR contains the work done to encapsulate the public models under a namespace, to avoid any possible ambiguities when developers use this package. Furthermore, some documentation has been updated an, of course, the available Xcode and Web documentation has been re-generated.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #19
2023-07-23 13:51:25 +00:00
cc34186d53 [Setup] License (#12)
This PR contains the work done to addres the issue #8, related to setting up a EUPL 1.2 license for this project.

To provide further details about the work done:
- [x] defined the LICENSE text;
- [x] defined the CONTRIBUTORS text;
- [x] added a header file to source code available in this project.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #12
2023-04-23 13:57:49 +00:00
c4a25afad4 [Setup] Documentation (#10)
This PR contains the work done to address the issue #7, related to documenting the source code that would be used for other developers.

To provide further details about the work done:
- [x] restructured the hierarchy of some models that are related to the `Amiibo` model;
- [x] written documentation for the `AmiiboService` service;
- [x] written documentation for the `AmiiboFilter` and `KeyNameFilter` filters;
- [x] written documentation for the `Amiibo`, `KeyName`, `LastUpdated` and children model;
- [x] written documentation for the `AmiiboClientError` error;
- [x] written documentation for the README file.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #10
2023-04-23 13:16:22 +00:00
a0dcdf7673 [Tweaks] Models (#5)
This PR contains the work done to make improvements to the existing models.

To provide further details about the work done:
- [x] moved the `games3DS`, `gamesWiiU` and `gamesSwitch` properties from the `Amiibo` model to their own `Games` child model;
- [x] improved the decoding of the `Result` model.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #5
2023-04-21 21:47:55 +00:00
f34ce5289d [Feature] Service (#4)
This PR contains the work done to implement the actual public service interface to the Amiibo API.

To provide further details about this work:
- [x] defined a `Filter` protocol;
- [x] implemented the `AmiiboFilter` and the `KeyNameFilter` filters;
- [x] implemented the `Result` model;
- [x] defined the `Service` protocol;
- [x] implemented the `AmiiboService` concrete service;
- [x] fixed the `path` of the `GetAmiiboEndpoint` endpoint;
- [x] made the `usage` property of the `Game` model optional;
- [x] replaced the `showGames` and the `showUsage` flags of the `AmiiboFilter` filter with an enumeration.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #4
2023-04-21 18:16:38 +00:00
29f766ebdb [Feature] Models of the service (#1)
This PR contains the implementation of all the models used by this service: `Amiibo`, `Amiibo.Game`, `Amiibo.Release`, `Amiibo.Usage`, `KeyName` and `LastUpdated`.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #1
2023-04-18 18:37:08 +00:00