Files
amiibo-service/docs/data/documentation/amiiboservice/amiiboserviceerror.json
T
javier 2442ada4b6 Documentation update (#26)
This PR contains the work done to update the documentation of the library, keeping it up-to-date.

Reviewed-on: #26
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2026-03-24 01:30:15 +00:00

1 line
9.9 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service could throw."}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/AmiiboService\/s8CopyableP","doc:\/\/AmiiboService\/SQ","doc:\/\/AmiiboService\/s5ErrorP","doc:\/\/AmiiboService\/s9EscapableP","doc:\/\/AmiiboService\/s8SendableP","doc:\/\/AmiiboService\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo"}],"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboserviceerror"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"},"metadata":{"roleHeading":"Enumeration","title":"AmiiboServiceError","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"externalID":"s:13AmiiboService0aB5ErrorO","modules":[{"name":"AmiiboService"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"role":"symbol","symbolKind":"enum"},"topicSections":[{"title":"Request errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled"],"anchor":"Request-errors"},{"title":"Response errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/decoding","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notFound"],"anchor":"Response-errors"},{"title":"Service errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notAvailable","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/undocumented(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/unknown"],"anchor":"Service-errors"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations"],"anchor":"Default-Implementations"}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Equatable-Implementations":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/equatable-implementations","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","kind":"article","type":"topic","abstract":[],"title":"Equatable Implementations","role":"collectionGroup"},"doc://AmiiboService/s5ErrorP":{"title":"Swift.Error","identifier":"doc:\/\/AmiiboService\/s5ErrorP","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/unknown":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/unknown","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/unknown","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"An unexpected error that does not fall into any other category."}],"title":"AmiiboServiceError.unknown","role":"symbol"},"doc://AmiiboService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/AmiiboService\/s16SendableMetatypeP","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboservice","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","abstract":[{"type":"text","text":"A type that implements the service that uses a client to make calls."}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"type":"topic","title":"AmiiboService"},"doc://AmiiboService/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/AmiiboService\/s8CopyableP","type":"unresolvable"},"doc://AmiiboService/s9EscapableP":{"title":"Swift.Escapable","identifier":"doc:\/\/AmiiboService\/s9EscapableP","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/notFound":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notFound","title":"AmiiboServiceError.notFound","abstract":[{"type":"text","text":"No results were found matching the given filter criteria."}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notfound","type":"topic","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"kind":"identifier","text":"notFound"}]},"doc://AmiiboService/documentation/AmiiboService/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."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror","kind":"symbol","role":"symbol","title":"AmiiboServiceError","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/decoding":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/decoding","title":"AmiiboServiceError.decoding","abstract":[{"type":"text","text":"The response body could not be decoded into the expected model."}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/decoding","type":"topic","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"decoding"}]},"doc://AmiiboService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/AmiiboService\/s8SendableP","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/badRequest":{"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/badrequest","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"badRequest"}],"role":"symbol","abstract":[{"text":"The request was malformed or contained invalid filter parameters.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest","type":"topic","title":"AmiiboServiceError.badRequest"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Error-Implementations":{"type":"topic","abstract":[],"title":"Error Implementations","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/error-implementations","role":"collectionGroup","kind":"article"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/notAvailable":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"notAvailable"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notavailable","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notAvailable","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The backend service is currently unreachable due to a network or server issue."}],"title":"AmiiboServiceError.notAvailable","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/cancelled":{"abstract":[{"text":"The request was cancelled before a response was received.","type":"text"}],"type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancelled","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/cancelled","kind":"symbol","role":"symbol","title":"AmiiboServiceError.cancelled","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/undocumented(_:)":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/undocumented(_:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/undocumented(_:)","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The server returned an undocumented HTTP status code."}],"title":"AmiiboServiceError.undocumented(_:)","role":"symbol"},"doc://AmiiboService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/AmiiboService\/SQ","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"text":" backend service.","type":"text"}],"kind":"symbol","url":"\/documentation\/amiiboservice","type":"topic","title":"AmiiboService","role":"collection"}}}