rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity

Overall improvements and data update (#22)

Browse Source 
This PR contains the work done to update the live tests to the latest data plus lots of QoL improvements to the library, including:

* added test cases to test the ``AmiiboService` locally;
* conformed the models to the `Hashable` protocol;
* documented the use of caching with the `AmiiboService` service;
* updated the reference to the new AmiiboAPI url;
* updated the year on the copyrights and header files;
* updated the overall documentation of the source code and the package.

Reviewed-on: #22
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 #22.
This commit is contained in:
Javier Cicchelli
2026-03-22 23:39:48 +00:00
committed by Javier Cicchelli
parent fae4b44698
commit 2b01ec14bf
375 changed files with 1177 additions and 700 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/data/documentation/amiiboservice/amiiboserviceerror/cancelled.json
+1 -1
View File
@@ -1 +1 @@
{"abstract":[{"text":"A call to an endpoint has been cancelled by the user.","type":"text"}],"metadata":{"roleHeading":"Case","role":"symbol","symbolKind":"case","title":"AmiiboServiceError.cancelled","externalID":"s:13AmiiboService0aB5ErrorO9cancelledyA2CmF","modules":[{"name":"AmiiboService"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancelled","kind":"identifier"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancelled","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboserviceerror\/cancelled"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/cancelled":{"type":"topic","abstract":[{"text":"A call to an endpoint has been cancelled by the user.","type":"text"}],"title":"AmiiboServiceError.cancelled","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancelled","kind":"identifier"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/cancelled"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"type":"topic","title":"AmiiboServiceError","url":"\/documentation\/amiiboservice\/amiiboserviceerror","role":"symbol","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service could throw."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","url":"\/documentation\/amiiboservice\/amiiboservice","kind":"symbol","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","title":"AmiiboService","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interact with the "},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"text":" backend service.","type":"text"}],"role":"collection","url":"\/documentation\/amiiboservice","kind":"symbol","type":"topic"}}}
{"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancelled","kind":"identifier"}],"platforms":["macOS"]}]}],"metadata":{"title":"AmiiboServiceError.cancelled","roleHeading":"Case","symbolKind":"case","modules":[{"name":"AmiiboService"}],"role":"symbol","externalID":"s:13AmiiboService0aB5ErrorO9cancelledyA2CmF","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancelled","kind":"identifier"}]},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"]]},"abstract":[{"type":"text","text":"The request was cancelled before a response was received."}],"seeAlsoSections":[{"generated":true,"title":"Request errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest"],"anchor":"Request-errors"}],"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/amiiboservice\/amiiboserviceerror\/cancelled"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled"},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/badRequest":{"fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"badRequest","kind":"identifier"}],"title":"AmiiboServiceError.badRequest","abstract":[{"text":"The request was malformed or contained invalid filter parameters.","type":"text"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/badrequest","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/cancelled":{"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/cancelled","type":"topic","title":"AmiiboServiceError.cancelled","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"cancelled","kind":"identifier"}],"abstract":[{"type":"text","text":"The request was cancelled before a response was received."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","url":"\/documentation\/amiiboservice\/amiiboservice","type":"topic","title":"AmiiboService","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"abstract":[{"text":"A representation of all the possible errors that the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","type":"reference"},{"type":"text","text":" service could throw."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"title":"AmiiboServiceError","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService":{"kind":"symbol","url":"\/documentation\/amiiboservice","role":"collection","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"inlineContent":[{"text":"Amiibo API","type":"text"}],"type":"strong"},{"text":" backend service.","type":"text"}],"title":"AmiiboService"}}}