rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity
amiibo-service/docs/data/documentation/amiiboservice/amiibo.json
Javier Cicchelli 6ba137a482 [Enhancement] Linux platform support (#17) 
This PR contains the work done to provide full support of this package to Linux platform, by removing the restriction on the `AmiiboClient` client and the `AmiiboService` service put in place on the `v1.0.1` release.

To provide further details about the work done:
- [x] updated the `SwiftLibs` package dependency to `v0.1.7`;
- [x] made the `AmiiboClient` client and the `AmiiboService` service available to Linux platforms by importing the `FoundationNetworking` framework when available;
- [x] updated the content of some DocC documentation pages;
- [x] regenerated the Xcode and Github pages documentation;
- [x] updated some text in the `README` file.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #17
2023-04-30 13:59:37 +00:00

1 line
17 KiB
JSON
Raw Blame History

{"seeAlsoSections":[{"title":"Models to decode the data coming from the responses","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Character","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated"],"generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"title":"Amiibo","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:13AmiiboService0A0V","modules":[{"name":"AmiiboService"}],"navigatorTitle":[{"kind":"identifier","text":"Amiibo"}]},"abstract":[{"type":"text","text":"This model struct represents an amiibo that is retrieved from the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},{"type":"text","text":"."}],"sections":[],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/AmiiboService\/Se"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"topicSections":[{"title":"Structures","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Release-swift.struct"]},{"title":"Instance Properties","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/character","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/gameSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/games-swift.property","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/head","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/image","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/name","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/release-swift.property","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/series","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/tail","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/type"]},{"title":"Default Implementations","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Decodable-Implementations"],"generated":true}],"variants":[{"paths":["\/documentation\/amiiboservice\/amiibo"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"languages":["swift"],"platforms":["macOS"]}]}],"references":{"doc://AmiiboService/documentation/AmiiboService/Amiibo/series":{"role":"symbol","title":"series","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"series"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The series the amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/series","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/series"},"doc://AmiiboService/documentation/AmiiboService/KeyName":{"role":"symbol","title":"KeyName","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeyName"}],"abstract":[{"type":"text","text":"This model is a concrete genetic definition that represents the following models: "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Character"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeyName"}],"url":"\/documentation\/amiiboservice\/keyname"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"role":"symbol","title":"GameSeries","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameSeries"}],"abstract":[{"type":"text","text":"This model represents the games series an amiibo is associated to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameSeries"}],"url":"\/documentation\/amiiboservice\/gameseries"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Decodable-Implementations":{"role":"collectionGroup","title":"Decodable Implementations","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Decodable-Implementations","kind":"article","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/decodable-implementations"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/character":{"role":"symbol","title":"character","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"character"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The character of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/character","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/character"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/name":{"role":"symbol","title":"name","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The name of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/name","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/name"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/tail":{"role":"symbol","title":"tail","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The last 8 values of the hexadecimal that identifies the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/tail","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/tail"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Games-swift.struct":{"role":"symbol","title":"Amiibo.Games","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Games"}],"abstract":[{"type":"text","text":"This model represents the list of games related to a particular amiibo, grouped by system."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Games-swift.struct","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Games"}],"url":"\/documentation\/amiiboservice\/amiibo\/games-swift.struct"},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"role":"symbol","title":"Amiibo","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"abstract":[{"type":"text","text":"This model struct represents an amiibo that is retrieved from the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"url":"\/documentation\/amiiboservice\/amiibo"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/image":{"role":"symbol","title":"image","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"image"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The URL to an image of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/image","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/image"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/gameSeries":{"role":"symbol","title":"gameSeries","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"gameSeries"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The game series of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/gameSeries","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/gameseries"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/games-swift.property":{"role":"symbol","title":"games","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"games"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Games","preciseIdentifier":"s:13AmiiboService0A0V5GamesV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The games related to the amiibo, if requested."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/games-swift.property","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/games-swift.property"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Release-swift.struct":{"role":"symbol","title":"Amiibo.Release","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Release"}],"abstract":[{"type":"text","text":"This model struct represents a collection of official release dates (if released) of an amiibo in different markets around the world."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Release-swift.struct","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Release"}],"url":"\/documentation\/amiiboservice\/amiibo\/release-swift.struct"},"doc://AmiiboService/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/AmiiboService\/Se"},"https://www.amiiboapi.com/docs/#showGames":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames","url":"https:\/\/www.amiiboapi.com\/docs\/#showGames"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/head":{"role":"symbol","title":"head","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"head"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The first 8 values of the hexadecimal that identifies the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/head","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/head"},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"role":"symbol","title":"AmiiboType","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboType"}],"abstract":[{"type":"text","text":"This model represents the type an amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}],"url":"\/documentation\/amiiboservice\/amiibotype"},"https://www.amiiboapi.com":{"title":"Amiibo API","titleInlineContent":[{"type":"text","text":"Amiibo API"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com","url":"https:\/\/www.amiiboapi.com"},"https://www.amiiboapi.com/docs/#amiibo":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo","url":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},"doc://AmiiboService/documentation/AmiiboService/Character":{"role":"symbol","title":"Character","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Character"}],"abstract":[{"type":"text","text":"This model represents the character an amiibo is associated to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Character","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Character"}],"url":"\/documentation\/amiiboservice\/character"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/type":{"role":"symbol","title":"type","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The type the amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/type","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/type"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Game":{"role":"symbol","title":"Amiibo.Game","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Game"}],"abstract":[{"type":"text","text":"This model structs represents a game that is related to an amiibo, when requested to the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Game"}],"url":"\/documentation\/amiiboservice\/amiibo\/game"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/release-swift.property":{"role":"symbol","title":"release","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"release"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Release","preciseIdentifier":"s:13AmiiboService0A0V7ReleaseV"}],"abstract":[{"type":"text","text":"The release dates of the amiibo (if released) in Australia, Europe, Japan and North America."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/release-swift.property","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo\/release-swift.property"},"doc://AmiiboService/documentation/AmiiboService/LastUpdated":{"role":"symbol","title":"LastUpdated","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"LastUpdated"}],"abstract":[{"type":"text","text":"This model represents the latest date when the remote API has been updated."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LastUpdated"}],"url":"\/documentation\/amiiboservice\/lastupdated"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeries":{"role":"symbol","title":"AmiiboSeries","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeries"}],"abstract":[{"type":"text","text":"This model represents the series an amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"url":"\/documentation\/amiiboservice\/amiiboseries"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[{"type":"text","text":"Ready-to-use service that retrieves decoded entities from any of the "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":" available endpoints."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"}}}
Reference in New Issue View Git Blame Copy Permalink