bc0ae63719
This PR contains the work done to: * Updated the library *DocC* documentation catalog; * Updated the library documentation for both *Xcode* and *GitHub Pages*; * Added the Swift version and compatibility badges to the README file; * Added the link to the *GitHub Pages* documentation in the *Swift Package Index* configuration. Reviewed-on: #13 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
8.8 KiB
JSON
1 line
8.8 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"kind":"symbol","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","type":"reference","isActive":true},{"type":"text","text":" service could throw."}],"topicSections":[{"anchor":"Enumeration-Cases","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/decoding","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notAvailable","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notFound","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/undocumented(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/unknown"],"generated":true,"title":"Enumeration Cases"},{"anchor":"Default-Implementations","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations"],"generated":true,"title":"Default Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboserviceerror"]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","interfaceLanguage":"swift"},"metadata":{"navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"roleHeading":"Enumeration","title":"AmiiboServiceError","modules":[{"name":"AmiiboService"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"externalID":"s:13AmiiboService0aB5ErrorO","symbolKind":"enum"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"relationshipsSections":[{"type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/AmiiboService\/s8CopyableP","doc:\/\/AmiiboService\/SQ","doc:\/\/AmiiboService\/s5ErrorP","doc:\/\/AmiiboService\/s8SendableP","doc:\/\/AmiiboService\/s16SendableMetatypeP"],"title":"Conforms To"}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/notAvailable":{"title":"AmiiboServiceError.notAvailable","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notAvailable","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notavailable","abstract":[{"type":"text","text":"An online service is not currently available."}],"role":"symbol","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notAvailable","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","kind":"symbol","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."}],"title":"AmiiboServiceError","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Error-Implementations":{"title":"Error Implementations","kind":"article","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/error-implementations","abstract":[],"role":"collectionGroup","type":"topic"},"doc://AmiiboService/s8CopyableP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s8CopyableP","title":"Swift.Copyable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/badRequest":{"title":"AmiiboServiceError.badRequest","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/badrequest","abstract":[{"type":"text","text":"A bad request has been given to the client."}],"role":"symbol","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"badRequest","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/unknown":{"title":"AmiiboServiceError.unknown","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/unknown","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/unknown","abstract":[{"type":"text","text":"An unknown error."}],"role":"symbol","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService":{"abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"text":" backend service.","type":"text"}],"url":"\/documentation\/amiiboservice","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","role":"collection","title":"AmiiboService","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/decoding":{"type":"topic","abstract":[{"type":"text","text":"A response cannot be decoded."}],"title":"AmiiboServiceError.decoding","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"decoding","kind":"identifier"}],"role":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/decoding","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/decoding"},"doc://AmiiboService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Equatable-Implementations":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/equatable-implementations","type":"topic","abstract":[],"kind":"article","title":"Equatable Implementations","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","role":"collectionGroup"},"doc://AmiiboService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s8SendableP","title":"Swift.Sendable"},"doc://AmiiboService/SQ":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/SQ","title":"Swift.Equatable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/undocumented(_:)":{"title":"AmiiboServiceError.undocumented(_:)","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/undocumented(_:)","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/undocumented(_:)","abstract":[{"type":"text","text":"An undocumented\/unsupported status code error."}],"role":"symbol","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboservice","title":"AmiiboService","abstract":[{"type":"text","text":"A type that implements the service that uses a client to make calls."}],"navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}]},"doc://AmiiboService/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s5ErrorP","title":"Swift.Error"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/notFound":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notfound","type":"topic","abstract":[{"type":"text","text":"A response cannot be found."}],"kind":"symbol","title":"AmiiboServiceError.notFound","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notFound","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"}]}}} |