rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity
Files
410a2006614e1923e0bb0414615bee9023fffd0e
amiibo-service/docs/data/documentation/amiiboservice/amiiboservice.json
T
javier 410a200661 GitHub Pages documentation support. (#5) 
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>
2025-09-09 18:34:29 +00:00

1 line
9.7 KiB
JSON
Raw Blame History

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}]}],"sections":[],"topicSections":[{"anchor":"Initializers","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)"],"title":"Initializers","generated":true},{"anchor":"Instance-Methods","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboSeries(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboTypes(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiibos(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameCharacters(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameSeries(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getLastUpdated()"],"title":"Instance Methods","generated":true}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboservice"]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A type that implements the service that uses a client to make calls."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboServiceAAV","role":"symbol","symbolKind":"struct","roleHeading":"Structure","title":"AmiiboService"},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboService/init(_:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)","abstract":[{"text":"Initializes this service with a specific client type.","type":"text"}],"title":"init(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/init(_:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6ClientO","text":"AmiiboClient"},{"kind":"text","text":")"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getGameCharacters(_:)":{"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameCharacters(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getGameCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV","text":"GameCharacterFilter","kind":"typeIdentifier"},{"text":") ","kind":"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":") -> ["},{"preciseIdentifier":"s:13AmiiboService13GameCharacterV","kind":"typeIdentifier","text":"GameCharacter"},{"text":"]","kind":"text"}],"title":"getGameCharacters(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/getgamecharacters(_:)","type":"topic","abstract":[{"text":"Gets a list of game characters based on a given filter.","type":"text"}],"role":"symbol"},"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":{"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/AmiiboService/getAmiiboSeries(_:)":{"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboservice\/getamiiboseries(_:)","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboSeries(_:)","abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}],"title":"getAmiiboSeries(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","kind":"typeIdentifier","text":"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"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService0A6SeriesV","kind":"typeIdentifier","text":"AmiiboSeries"},{"kind":"text","text":"]"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getAmiiboTypes(_:)":{"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboTypes(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A10TypeFilterV","text":"AmiiboTypeFilter"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A4TypeV","text":"AmiiboType","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"title":"getAmiiboTypes(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/getamiibotypes(_:)","type":"topic","abstract":[{"type":"text","text":"Gets a list of amiibo types based on a given filter."}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getLastUpdated()":{"url":"\/documentation\/amiiboservice\/amiiboservice\/getlastupdated()","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLastUpdated"},{"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":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Gets the date when the data was last updated."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getLastUpdated()","title":"getLastUpdated()"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getAmiibos(_:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiibos(_:)","title":"getAmiibos(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/getamiibos(_:)","abstract":[{"type":"text","text":"Gets a list of amiibo items based on a given filter."}],"kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV"},{"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":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"]"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getGameSeries(_:)":{"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboservice\/getgameseries(_:)","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameSeries(_:)","title":"getGameSeries(_:)","abstract":[{"text":"Gets a list of game series based on a given filter.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameSeries","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","text":"GameSeriesFilter","kind":"typeIdentifier"},{"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"},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"role":"symbol"}}}
Reference in New Issue View Git Blame Copy Permalink