rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity
Files
7e7e194abc245aa3eaea32b67231474bc51007fd
amiibo-service/docs/data/documentation/amiiboservice/amiiboliveclient.json
T
javier 2b01ec14bf Overall improvements and data update (#22) 
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>
2026-03-22 23:39:48 +00:00

1 line
12 KiB
JSON
Raw Blame History

{"topicSections":[{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)"],"title":"Initializers","anchor":"Initializers"},{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)"],"title":"Amiibo endpoints","anchor":"Amiibo-endpoints"},{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)"],"title":"Game endpoints","anchor":"Game-endpoints"},{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()"],"title":"System endpoints","anchor":"System-endpoints"},{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/AmiiboClient-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","doc:\/\/AmiiboService\/s8CopyableP","doc:\/\/AmiiboService\/s9EscapableP","doc:\/\/AmiiboService\/s8SendableP","doc:\/\/AmiiboService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To"}],"kind":"symbol","identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","interfaceLanguage":"swift"},"metadata":{"symbolKind":"struct","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"roleHeading":"Structure","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService0A10LiveClientV","role":"symbol","title":"AmiiboLiveClient","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}]},"sections":[],"seeAlsoSections":[{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"],"generated":true,"title":"Clients","anchor":"Clients"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboliveclient"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]}],"abstract":[{"type":"text","text":"A type that implements a live client to the "},{"type":"reference","identifier":"https:\/\/www.amiiboapi.org","isActive":true},{"type":"text","text":" online service."}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboSeries(by:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getAmiiboSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"AmiiboSeriesFilter","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"AmiiboSeries","preciseIdentifier":"s:13AmiiboService0A6SeriesV","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiiboseries(by:)","title":"getAmiiboSeries(by:)","role":"symbol","abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getLastUpdated()":{"abstract":[{"type":"text","text":"Gets the date when the data was last updated."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getlastupdated()","title":"getLastUpdated()","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLastUpdated"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getGameSeries(by:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","text":"GameSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries"},{"kind":"text","text":"]"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgameseries(by:)","title":"getGameSeries(by:)","role":"symbol","abstract":[{"type":"text","text":"Gets a list of game series based on a given filter."}]},"https://www.amiiboapi.org":{"identifier":"https:\/\/www.amiiboapi.org","title":"Amiibo API","url":"https:\/\/www.amiiboapi.org","type":"link","titleInlineContent":[{"type":"text","text":"Amiibo API"}]},"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"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboTypes(by:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A10TypeFilterV","text":"AmiiboTypeFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A4TypeV","text":"AmiiboType"},{"kind":"text","text":"]"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibotypes(by:)","title":"getAmiiboTypes(by:)","role":"symbol","abstract":[{"type":"text","text":"Gets a list of amiibo types based on a given filter."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getGameCharacters(by:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameCharacters"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV","text":"GameCharacterFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService13GameCharacterV","text":"GameCharacter"},{"kind":"text","text":"]"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgamecharacters(by:)","title":"getGameCharacters(by:)","role":"symbol","abstract":[{"type":"text","text":"Gets a list of game characters based on a given filter."}]},"doc://AmiiboService/s8CopyableP":{"identifier":"doc:\/\/AmiiboService\/s8CopyableP","title":"Swift.Copyable","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/init(transport:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","text":"ClientTransport"},{"kind":"text","text":")"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/init(transport:)","title":"init(transport:)","role":"symbol","abstract":[{"type":"text","text":"Initializes this client with a transport for performing HTTP operations."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboLiveClient"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","url":"\/documentation\/amiiboservice\/amiiboliveclient","type":"topic","title":"AmiiboLiveClient","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"abstract":[{"type":"text","text":"A type that implements a live client to the "},{"isActive":true,"identifier":"https:\/\/www.amiiboapi.org","type":"reference"},{"text":" online service.","type":"text"}]},"doc://AmiiboService/s9EscapableP":{"identifier":"doc:\/\/AmiiboService\/s9EscapableP","title":"Swift.Escapable","type":"unresolvable"},"doc://AmiiboService/s16SendableMetatypeP":{"identifier":"doc:\/\/AmiiboService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/AmiiboClient-Implementations":{"kind":"article","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/AmiiboClient-Implementations","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/amiiboclient-implementations","title":"AmiiboClient Implementations","role":"collectionGroup","abstract":[]},"doc://AmiiboService/s8SendableP":{"identifier":"doc:\/\/AmiiboService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiibos(by:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibos(by:)","title":"getAmiibos(by:)","role":"symbol","abstract":[{"type":"text","text":"Gets a list of amiibo items based on a given filter."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboClient","kind":"identifier"}],"title":"AmiiboClient","navigatorTitle":[{"text":"AmiiboClient","kind":"identifier"}],"abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboclient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"}}}
Reference in New Issue View Git Blame Copy Permalink