rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity
24 Commits 2 Branches 16 Tags
5521e295999bc398b177298c80cf0d95903543e7
Commit Graph

10 Commits

Author SHA1 Message Date
javier 5521e29599 Improved the definition of the GET /amiibo endpoint for the OpenAPI specification document in the library target. 2025-10-15 00:24:01 +02:00
javier 972c2f4487 Improved the definition of the GET /series endpoint for the OpenAPI specification document in the library target. 2025-10-14 23:54:38 +02:00
javier df8c650f9d Improved the definition of the GET /character endpoint for the OpenAPI specification document in the library target. 2025-10-14 23:48:05 +02:00
javier 739182a7ae Improved the definition of the GET /gameseries endpoint for the OpenAPI specification document in the library target. 2025-10-14 23:42:11 +02:00
javier 9140707712 Improved the definition of the GET /type endpoint for the OpenAPI specification document in the library target. 2025-10-14 23:31:10 +02:00
javier 1e8a9faa39 Updated the definition of the GET /lastupdated endpoint for the OpenAPI specification document in the library target. 2025-10-14 23:27:36 +02:00
javier 0bad58f00b Declared the "Key" and "Name" parameters for the components of the Open API specification document in the library target. 2025-10-14 22:23:31 +02:00
javier 34627840db Some fixes to the latest updates (#18) 
This PR contains the work done to:
* update the header files of all the existing source files in the project with the Apache License;
* update the main article of the `DocC` documentation catalog;
* update the `README` file;
* regenerate the Github Pages documentation from the `DocC` documentation catalog.

Reviewed-on: #18
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
 2025-10-07 22:32:54 +00:00
javier 40afefed15 Open API specification improvements and License update (#17) 
This PR contains the work done to:
* improve the overall `OpenAPI` specification documentation describing the `Amiibo API` service;
* update the `AmiiboFilter` type to include the `head` and `tail` properties;
* update the error handling of the errors coming up from the service;
* update its license to Apache v2.0;
* regenerate the Github Pages documentation.

Reviewed-on: #17
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
 2025-10-07 22:07:55 +00:00
javier 0af0e3056d Patched (temporarily) the DocC documentation (#8) 
This PR contains the work done to:
* Documented the public properties, initializers, and/or functions of those types conforming to the `APIClient`, `KeyNameFilter`, and `KeyNameModel` protocols, to fix the issue that the protocol documentations cannot be inherited;
* Moved the `AmiiboService` DocC documentation catalog inside the library target;
* Amended the folder structure of the library and test targets;
* Fixed further documentation issues encountered while revising the written documentation;
* Added the `lib-test` task in the `Makefile` file;
* Improved the naming for the existing tasks in the `Makefile` file.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
 2025-09-10 19:47:45 +00:00