rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity
Files
565f02bd6977b263aee95ffa62cc4f7174fdde4a
amiibo-service/docs/data/documentation/amiiboservice/amiiboliveclient.json
T
javier 4623c13c24 Improved the Open API specification document (#19) 
This PR contains the work done to improve the `OpenAPI` specification documentation that describes the `Amiibo API` online service as well as updates to the `AmiiboLiveClient` that uses the code generated out of the mentioned document. In addition, some test cases have been updated to reflect the latest data in the service.

Reviewed-on: #19
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-14 23:26:42 +00:00

1 line
12 KiB
JSON
Raw Blame History

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