javier
410a200661
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>
1 line
8.8 KiB
JSON
1 line
8.8 KiB
JSON
{"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/AmiiboService\/s8CopyableP","doc:\/\/AmiiboService\/SQ","doc:\/\/AmiiboService\/s5ErrorP","doc:\/\/AmiiboService\/s8SendableP","doc:\/\/AmiiboService\/s16SendableMetatypeP"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"sections":[],"topicSections":[{"title":"Enumeration Cases","generated":true,"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"],"anchor":"Enumeration-Cases"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations"],"anchor":"Default-Implementations"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboserviceerror"]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"text":" service could throw.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"AmiiboService"}],"title":"AmiiboServiceError","role":"symbol","symbolKind":"enum","externalID":"s:13AmiiboService0aB5ErrorO","navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboServiceError"}],"roleHeading":"Enumeration"},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/unknown":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/unknown","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"An unknown error."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/unknown","title":"AmiiboServiceError.unknown"},"doc://AmiiboService/s8SendableP":{"identifier":"doc:\/\/AmiiboService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/decoding":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/decoding","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"decoding","kind":"identifier"}],"abstract":[{"type":"text","text":"A response cannot be decoded."}],"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/decoding","title":"AmiiboServiceError.decoding","type":"topic","role":"symbol"},"doc://AmiiboService/s16SendableMetatypeP":{"identifier":"doc:\/\/AmiiboService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://AmiiboService/SQ":{"identifier":"doc:\/\/AmiiboService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"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/AmiiboServiceError/undocumented(_:)":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/undocumented(_:)","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"An undocumented\/unsupported status code error."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/undocumented(_:)","title":"AmiiboServiceError.undocumented(_:)"},"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/notFound":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notFound","title":"AmiiboServiceError.notFound","type":"topic","abstract":[{"text":"A response cannot be found.","type":"text"}],"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notfound","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/notAvailable":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notAvailable","title":"AmiiboServiceError.notAvailable","type":"topic","abstract":[{"text":"An online service is not currently available.","type":"text"}],"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notavailable","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"notAvailable"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/badRequest":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/badrequest","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"badRequest","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A bad request has been given to the client.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest","title":"AmiiboServiceError.badRequest"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Error-Implementations":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/error-implementations","type":"topic","kind":"article","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations","title":"Error Implementations"},"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/s5ErrorP":{"identifier":"doc:\/\/AmiiboService\/s5ErrorP","title":"Swift.Error","type":"unresolvable"},"doc://AmiiboService/s8CopyableP":{"identifier":"doc:\/\/AmiiboService\/s8CopyableP","title":"Swift.Copyable","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Equatable-Implementations":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/equatable-implementations","type":"topic","kind":"article","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","title":"Equatable Implementations"}}} |