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

GitHub Pages documentation support. (#5)

Browse Source 
This PR contains the work done to:
* Update the `Library` article in the DocC documentation catalog in the project;
* Generate the DocC documentation of the library for GitHub Pages;
* Written the `README` file in the project.

Reviewed-on: #5
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 #5.
This commit is contained in:
javier authored and Javier Cicchelli committed 2025-09-09 18:34:29 +00:00
1 parent 37c0f3e322
commit 410a200661
277 files changed
+690 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/data/documentation/amiiboservice/amiibomockclient/getamiibos(by:).json
+1
View File
@@ -0,0 +1 @@
{"metadata":{"modules":[{"name":"AmiiboService"}],"title":"getAmiibos(by:)","role":"symbol","extendedModule":"AmiiboService","externalID":"s:13AmiiboService0A10MockClientV10getAmiibos2bySayAA0A0VGAA0A6FilterV_tYaAA0aB5ErrorOYKF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getAmiibos","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"text":": ","kind":"text"},{"text":"AmiiboFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6FilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"text":"Amiibo","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A0V"},{"text":"]","kind":"text"}],"roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiibos(by:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","kind":"typeIdentifier","text":"AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"},{"kind":"text","text":") -> ["},{"text":"Amiibo","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"text":"]","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiibomockclient\/getamiibos(by:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"url":"\/documentation\/amiiboservice\/amiibo","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Amiibo"}],"navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A model that represents an amiibo item.","type":"text"}],"title":"Amiibo","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboService","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboservice","role":"symbol","type":"topic","title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceError","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true},{"type":"text","text":" service could throw."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"title":"AmiiboFilter","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboFilter","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","type":"topic","abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo items.","type":"text"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboFilter"}],"url":"\/documentation\/amiiboservice\/amiibLine truncated
docs/data/documentation/amiiboservice/amiibomockclient/getamiiboseries(by:).json
+1
View File
@@ -0,0 +1 @@
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiiboSeries(by:)"},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","kind":"typeIdentifier","text":"AmiiboSeriesFilter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService0A6SeriesV","kind":"typeIdentifier","text":"AmiiboSeries","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries"},{"kind":"text","text":"]"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]]},"metadata":{"modules":[{"name":"AmiiboService"}],"title":"getAmiiboSeries(by:)","role":"symbol","extendedModule":"AmiiboService","externalID":"s:13AmiiboService0A10MockClientV03getA6Series2bySayAA0aF0VGAA0aF6FilterV_tYaAA0aB5ErrorOYKF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AmiiboSeriesFilter","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"AmiiboSeries","preciseIdentifier":"s:13AmiiboService0A6SeriesV"},{"kind":"text","text":"]"}],"roleHeading":"Instance Method"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiibomockclient\/getamiiboseries(by:)"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceError","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true},{"type":"text","text":" service could throw."}]},"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"role":"collection","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiibomockclient","kind":"symbol","navigatorTitle":[{"text":"AmiiboMockClient","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboMockClient"}],"title":"AmiiboMockClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","type":"topic","abstract":[{"type":"text","text":"A type that implements a mock client, for testing purposes."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboService","kind":"identifier"}],"url":"\/documentation\/amiiboservice\Line truncated
docs/data/documentation/amiiboservice/amiibomockclient/getamiibotypes(by:).json
+1
View File
@@ -0,0 +1 @@
{"sections":[],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiibomockclient\/getamiibotypes(by:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiiboTypes(by:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A10TypeFilterV","kind":"typeIdentifier","text":"AmiiboTypeFilter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService0A4TypeV","kind":"typeIdentifier","text":"AmiiboType","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType"},{"kind":"text","text":"]"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"modules":[{"name":"AmiiboService"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AmiiboTypeFilter","preciseIdentifier":"s:13AmiiboService0A10TypeFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"AmiiboType","preciseIdentifier":"s:13AmiiboService0A4TypeV"},{"kind":"text","text":"]"}],"extendedModule":"AmiiboService","roleHeading":"Instance Method","externalID":"s:13AmiiboService0A10MockClientV03getA5Types2bySayAA0A4TypeVGAA0aH6FilterV_tYaAA0aB5ErrorOYKF","title":"getAmiiboTypes(by:)","role":"symbol","symbolKind":"method"},"references":{"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"role":"collection","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiibomockclient","kind":"symbol","navigatorTitle":[{"text":"AmiiboMockClient","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboMockClient"}],"title":"AmiiboMockClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","type":"topic","abstract":[{"type":"text","text":"A type that implements a mock client, for testing purposes."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceError","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true},{"type":"text","text":" service could throw."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"url":"\/documentation\/amiiboservice\/amiibotype","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","abstract":[{"type":"text","text":"A model that represents an amiibo type."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboType","kind":"identifier"}],"role":"symbol","title":"AmiiboType","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}]Line truncated
docs/data/documentation/amiiboservice/amiibomockclient/getgamecharacters(by:).json
+1
View File
@@ -0,0 +1 @@
{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","kind":"typeIdentifier","text":"GameCharacterFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","kind":"typeIdentifier","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService13GameCharacterV","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","kind":"typeIdentifier","text":"GameCharacter"},{"kind":"text","text":"]"}]}]}],"metadata":{"roleHeading":"Instance Method","extendedModule":"AmiiboService","externalID":"s:13AmiiboService0A10MockClientV17getGameCharacters2bySayAA0F9CharacterVGAA0fI6FilterV_tYaAA0aB5ErrorOYKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getGameCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"GameCharacterFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"AmiiboServiceError","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService13GameCharacterV","text":"GameCharacter","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"title":"getGameCharacters(by:)","modules":[{"name":"AmiiboService"}],"symbolKind":"method","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiibomockclient\/getgamecharacters(by:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getGameCharacters(by:)"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]]},"kind":"symbol","references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getGameCharacters(by:)":{"title":"getGameCharacters(by:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV","text":"GameCharacterFilter","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService13GameCharacterV","text":"GameCharacter"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getGameCharacters(by:)","url":"\/documentation\/amiiboservice\/amiibomockclient\/getgamecharacters(by:)","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/GameCharacterFilter":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","abstract":[{"text":"A type that contains values to fine-tune a response when requesting game characters.","type":"text"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameCharacterFilter","kind":"identifier"}],"title":"GameCharacterFilter","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"GameCharacterFilter"}],"url":"\/documentation\/amiiboservice\/gamecharacterfilter","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceELine truncated
docs/data/documentation/amiiboservice/amiibomockclient/getgameseries(by:).json
+1
View File
@@ -0,0 +1 @@
{"sections":[],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiibomockclient\/getgameseries(by:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getGameSeries(by:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"filter","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","text":"GameSeriesFilter","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","kind":"typeIdentifier","text":"GameSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","kind":"typeIdentifier","text":"GameSeries"},{"kind":"text","text":"]"}],"modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService0A10MockClientV13getGameSeries2bySayAA0fG0VGAA0fG6FilterV_tYaAA0aB5ErrorOYKF","extendedModule":"AmiiboService","role":"symbol","symbolKind":"method","roleHeading":"Instance Method","title":"getGameSeries(by:)"},"references":{"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"role":"collection","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiibomockclient","kind":"symbol","navigatorTitle":[{"text":"AmiiboMockClient","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboMockClient"}],"title":"AmiiboMockClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","type":"topic","abstract":[{"type":"text","text":"A type that implements a mock client, for testing purposes."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceError","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true},{"type":"text","text":" service could throw."}]},"doc://AmiiboService/documentation/AmiiboService/GameSeriesFilter":{"title":"GameSeriesFilter","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameSeriesFilter","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","type":"topic","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting game series."}],"role":"symbol","navigatorTitle":[{"text":"GameSeLine truncated
docs/data/documentation/amiiboservice/amiibomockclient/getlastupdated().json
+1
View File
@@ -0,0 +1 @@
{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"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"},{"text":"(","kind":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"languages":["swift"],"platforms":["macOS"]}]}],"metadata":{"roleHeading":"Instance Method","externalID":"s:13AmiiboService0A10MockClientV14getLastUpdated10Foundation4DateVyYaAA0aB5ErrorOYKF","extendedModule":"AmiiboService","symbolKind":"method","title":"getLastUpdated()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLastUpdated","kind":"identifier"},{"kind":"text","text":"() "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"role":"symbol","modules":[{"name":"AmiiboService"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getLastUpdated()"},"variants":[{"paths":["\/documentation\/amiiboservice\/amiibomockclient\/getlastupdated()"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getLastUpdated()":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getLastUpdated()","abstract":[],"kind":"symbol","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"},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}],"url":"\/documentation\/amiiboservice\/amiibomockclient\/getlastupdated()","role":"symbol","type":"topic","title":"getLastUpdated()"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboService","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboservice","role":"symbol","type":"topic","title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"url":"\/documentation\/amiiboservice\/amiibomockclient","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboMockClient"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboMockClient"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A type that implements a mock client, for testing purposes."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","title":"AmiiboMockClient"},"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"role":"collection","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceError","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{Line truncated
docs/data/documentation/amiiboservice/amiibomockclient/init(amiibos:amiiboseries:amiibotypes:gamecharacters:gameseries:lastupdated:error:).json
+1
View File
@@ -0,0 +1 @@
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/init(amiibos:amiiboSeries:amiiboTypes:gameCharacters:gameSeries:lastUpdated:error:)"},"sections":[],"metadata":{"modules":[{"name":"AmiiboService"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"amiibos"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A0V","text":"Amiibo"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"amiiboSeries"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"amiiboTypes"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:13AmiiboService0A4TypeV","kind":"typeIdentifier","text":"AmiiboType"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"gameCharacters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService13GameCharacterV","text":"GameCharacter"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"gameSeries"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","kind":"typeIdentifier","text":"GameSeries"},{"kind":"text","text":"]?, "},{"text":"lastUpdated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":"?, ","kind":"text"},{"text":"error","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError"},{"kind":"text","text":"?)"}],"roleHeading":"Initializer","externalID":"s:13AmiiboService0A10MockClientV7amiibos12amiiboSeries0F5Types14gameCharacters0iG011lastUpdated5errorACSayAA0A0VGSg_SayAA0aG0VGSgSayAA0A4TypeVGSgSayAA13GameCharacterVGSgSayAA0oG0VGSg10Foundation4DateVSgAA0aB5ErrorOSgtcfc","symbolKind":"init","role":"symbol","title":"init(amiibos:amiiboSeries:amiiboTypes:gameCharacters:gameSeries:lastUpdated:error:)"},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiibomockclient\/init(amiibos:amiiboseries:amiibotypes:gamecharacters:gameseries:lastupdated:error:)"]}],"abstract":[{"type":"text","text":"Initializes this client."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"amiibos","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"Amiibo","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"amiiboSeries"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","text":"AmiiboSeries"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"amiiboTypes"},{"kind":"text","text":": ["},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A4TypeV","text":"AmiiboType"},{"text":"]? = nil, ","kind":"text"},{"text":"gameCharacters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService13GameCharacterV","text":"GameCharacter","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter"},{"text":"]? = nil, ","kind":"text"},{"text":"gameSeries","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"},{"text":"]? = nil, ","kind":"text"},{"text":"lastUpdated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"error","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","text":"AmiiboServiceError"},{"kind":"text","text":"? = nil)"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"A list of amiibo items to return, if any.","type":"text"}],"type":"paragraph"}],"name":"amiibos"},{"content":[{"inlineContent":[{"text":"A list of amiibo series to return, if any.","type":"text"}],"type":"paraLine truncated