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
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
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
