Files
amiibo-service/docs/data/documentation/amiiboservice/amiiboliveclient/amiiboclient-implementations.json
T
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

1 line
8.2 KiB
JSON

{"sections":[],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"]]},"metadata":{"modules":[{"name":"AmiiboService"}],"role":"collectionGroup","title":"AmiiboClient Implementations","roleHeading":"API Collection"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboliveclient\/amiiboclient-implementations"]}],"kind":"article","topicSections":[{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()"],"anchor":"Instance-Methods","title":"Instance Methods","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/AmiiboClient-Implementations","interfaceLanguage":"swift"},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getLastUpdated()":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()","abstract":[{"text":"Gets the date when the data was last updated.","type":"text"}],"role":"symbol","title":"getLastUpdated()","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getlastupdated()","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getLastUpdated"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboSeries(by:)":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","title":"getAmiiboSeries(by:)","abstract":[{"text":"Gets a list of amiibo series based on a given filter.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries"},{"kind":"text","text":"]"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiiboseries(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiibos(by:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A6FilterV","kind":"typeIdentifier","text":"AmiiboFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"preciseIdentifier":"s:13AmiiboService0A0V","kind":"typeIdentifier","text":"Amiibo"},{"kind":"text","text":"]"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","role":"symbol","abstract":[{"text":"Gets a list of amiibo items based on a given filter.","type":"text"}],"title":"getAmiibos(by:)","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibos(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"title":"AmiiboLiveClient","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","role":"symbol","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboLiveClient","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService":{"abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"inlineContent":[{"type":"text","text":"Amiibo API"}],"type":"strong"},{"text":" backend service.","type":"text"}],"type":"topic","kind":"symbol","role":"collection","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","title":"AmiiboService","url":"\/documentation\/amiiboservice"},"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","text":"GameSeriesFilter","preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"GameSeries","preciseIdentifier":"s:13AmiiboService10GameSeriesV"},{"kind":"text","text":"]"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)","role":"symbol","abstract":[{"type":"text","text":"Gets a list of game series based on a given filter."}],"title":"getGameSeries(by:)","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgameseries(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getGameCharacters(by:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","abstract":[{"text":"Gets a list of game characters based on a given filter.","type":"text"}],"role":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgamecharacters(by:)","title":"getGameCharacters(by:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"GameCharacterFilter","preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"GameCharacter","preciseIdentifier":"s:13AmiiboService13GameCharacterV","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboTypes(by:)":{"type":"topic","title":"getAmiiboTypes(by:)","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibotypes(by:)","abstract":[{"type":"text","text":"Gets a list of amiibo types based on a given filter."}],"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiiboTypes","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A10TypeFilterV","text":"AmiiboTypeFilter","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A4TypeV","text":"AmiiboType","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)"}}}