rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity
amiibo-service/Sources/AmiiboService.docc/AmiiboService.md

43 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

[Setup] DocC (#13) This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project. To provide further details about the work done: - [x] created the documentation catalog for the project in Xcode; - [x] added the `Swift-DocC-Plugin` dependency to the `Package` file; - [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file; - [x] generated documentation for Xcode and Github pages; - [x] added the package logo assets to the project; - [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes; - [x] added the `.env` file to the `.gitignore` file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/13
2023-04-24 15:07:21 +00:00
# ``AmiiboService``
[Tweaks] DocC documentation (#15) This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages. To provide further details about the work done: - [x] written the *Getting Started* article in the documentation catalog; - [x] written the *AmiiboService* article in the documentation catalog; - [x] updated the text of the `README` file; - [x] downgraded the Swift tool version in the `Package` file to v5.5; - [x] added the missing header file to the `Package` file; - [x] updated the `SwiftLibs` package dependency to its latest release; - [x] re-generated the documentation targeting Xcode and Github pages. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/15
2023-04-25 14:29:23 +00:00
Ready-to-use service that retrieves decoded entities from any of the [Amiibo API](https://www.amiiboapi.com) available endpoints.
[Setup] DocC (#13) This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project. To provide further details about the work done: - [x] created the documentation catalog for the project in Xcode; - [x] added the `Swift-DocC-Plugin` dependency to the `Package` file; - [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file; - [x] generated documentation for Xcode and Github pages; - [x] added the package logo assets to the project; - [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes; - [x] added the `.env` file to the `.gitignore` file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/13
2023-04-24 15:07:21 +00:00
## Overview
[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: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/19
2023-07-23 13:51:25 +00:00
**AmiiboService** provides a service for retrieving data from the remote [Amiibo API](https://www.amiiboapi.com) endpoints that could be used in either in libraries and applications, targeting not only Apple platforms, such as *iOS*, *macOS*, *tvOS*, *watchOS*, and *xrOS*; but *Linux* and *Windows* platforms as well.
This package provides all the necessary components to the developers to:
* data filtering parameters to the requests to send to the remote service, if required;
* decoded models from the data coming in from those responses.
[Setup] DocC (#13) This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project. To provide further details about the work done: - [x] created the documentation catalog for the project in Xcode; - [x] added the `Swift-DocC-Plugin` dependency to the `Package` file; - [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file; - [x] generated documentation for Xcode and Github pages; - [x] added the package logo assets to the project; - [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes; - [x] added the `.env` file to the `.gitignore` file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/13
2023-04-24 15:07:21 +00:00
## Topics
[Tweaks] DocC documentation (#15) This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages. To provide further details about the work done: - [x] written the *Getting Started* article in the documentation catalog; - [x] written the *AmiiboService* article in the documentation catalog; - [x] updated the text of the `README` file; - [x] downgraded the Swift tool version in the `Package` file to v5.5; - [x] added the missing header file to the `Package` file; - [x] updated the `SwiftLibs` package dependency to its latest release; - [x] re-generated the documentation targeting Xcode and Github pages. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/15
2023-04-25 14:29:23 +00:00
### Essentials
[Setup] DocC (#13) This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project. To provide further details about the work done: - [x] created the documentation catalog for the project in Xcode; - [x] added the `Swift-DocC-Plugin` dependency to the `Package` file; - [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file; - [x] generated documentation for Xcode and Github pages; - [x] added the package logo assets to the project; - [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes; - [x] added the `.env` file to the `.gitignore` file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/13
2023-04-24 15:07:21 +00:00
[Tweaks] DocC documentation (#15) This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages. To provide further details about the work done: - [x] written the *Getting Started* article in the documentation catalog; - [x] written the *AmiiboService* article in the documentation catalog; - [x] updated the text of the `README` file; - [x] downgraded the Swift tool version in the `Package` file to v5.5; - [x] added the missing header file to the `Package` file; - [x] updated the `SwiftLibs` package dependency to its latest release; - [x] re-generated the documentation targeting Xcode and Github pages. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/15
2023-04-25 14:29:23 +00:00
- <doc:GettingStarted>
- ``AmiiboService/AmiiboService``
[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: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/19
2023-07-23 13:51:25 +00:00
### Models
- ``DTO``
- ``DTO/Amiibo``
- ``DTO/KeyName``
- ``DTO/AmiiboSeries``
- ``DTO/AmiiboType``
- ``DTO/Character``
- ``DTO/GameSeries``
- ``DTO/LastUpdated``
### Filters
[Tweaks] DocC documentation (#15) This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages. To provide further details about the work done: - [x] written the *Getting Started* article in the documentation catalog; - [x] written the *AmiiboService* article in the documentation catalog; - [x] updated the text of the `README` file; - [x] downgraded the Swift tool version in the `Package` file to v5.5; - [x] added the missing header file to the `Package` file; - [x] updated the `SwiftLibs` package dependency to its latest release; - [x] re-generated the documentation targeting Xcode and Github pages. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/15
2023-04-25 14:29:23 +00:00
- ``AmiiboFilter``
- ``KeyNameFilter``
- ``AmiiboSeriesFilter`` 
- ``AmiiboTypeFilter``
- ``CharacterFilter``
- ``GameSeriesFilter``
[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: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/19
2023-07-23 13:51:25 +00:00
### Errors
[Tweaks] DocC documentation (#15) This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages. To provide further details about the work done: - [x] written the *Getting Started* article in the documentation catalog; - [x] written the *AmiiboService* article in the documentation catalog; - [x] updated the text of the `README` file; - [x] downgraded the Swift tool version in the `Package` file to v5.5; - [x] added the missing header file to the `Package` file; - [x] updated the `SwiftLibs` package dependency to its latest release; - [x] re-generated the documentation targeting Xcode and Github pages. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: https://repo.rock-n-code.com/rock-n-code/amiibo-service/pulls/15
2023-04-25 14:29:23 +00:00
- ``AmiiboClientError``
Reference in New Issue Copy Permalink