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>
This commit was merged in pull request #26.
This commit is contained in:
2026-03-24 01:30:15 +00:00
committed by Javier Cicchelli
parent b8c0878ca3
commit 2442ada4b6
136 changed files with 136 additions and 136 deletions
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +1 @@
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)"},"kind":"symbol","metadata":{"symbolKind":"init","roleHeading":"Initializer","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService0A10LiveClientV9transportAC14OpenAPIRuntime0D9Transport_p_tcfc","role":"symbol","title":"init(transport:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","text":"ClientTransport","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboliveclient\/init(transport:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","text":"ClientTransport"},{"kind":"text","text":" = URLSessionTransport())"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"A transport that performs HTTP operations. Defaults to a "},{"code":"URLSessionTransport","type":"codeVoice"},{"type":"text","text":" using the shared session."}],"type":"paragraph"}],"name":"transport"}]}],"abstract":[{"type":"text","text":"Initializes this client with a transport for performing HTTP operations."}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/init(transport:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","text":"ClientTransport"},{"kind":"text","text":")"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient\/init(transport:)","title":"init(transport:)","role":"symbol","abstract":[{"type":"text","text":"Initializes this client with a transport for performing HTTP operations."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboLiveClient"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","url":"\/documentation\/amiiboservice\/amiiboliveclient","type":"topic","title":"AmiiboLiveClient","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"abstract":[{"type":"text","text":"A type that implements a live client to the "},{"isActive":true,"identifier":"https:\/\/www.amiiboapi.org","type":"reference"},{"text":" online service.","type":"text"}]},"doc://AmiiboService/documentation/AmiiboService":{"kind":"symbol","url":"\/documentation\/amiiboservice","role":"collection","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"inlineContent":[{"text":"Amiibo API","type":"text"}],"type":"strong"},{"text":" backend service.","type":"text"}],"title":"AmiiboService"},"https://www.amiiboapi.org":{"identifier":"https:\/\/www.amiiboapi.org","title":"Amiibo API","titleInlineContent":[{"type":"text","text":"Amiibo API"}],"url":"https:\/\/www.amiiboapi.org","type":"link"}}}
{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)"},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboliveclient\/init(transport:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Initializes this client with a transport for performing HTTP operations."}],"metadata":{"symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"text":")","kind":"text"}],"roleHeading":"Initializer","externalID":"s:13AmiiboService0A10LiveClientV9transportAC14OpenAPIRuntime0D9Transport_p_tcfc","modules":[{"name":"AmiiboService"}],"role":"symbol","title":"init(transport:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"text":" = URLSessionTransport())","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"A transport that performs HTTP operations. Defaults to a ","type":"text"},{"type":"codeVoice","code":"URLSessionTransport"},{"text":" using the shared session.","type":"text"}]}],"name":"transport"}],"kind":"parameters"}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"abstract":[{"type":"text","text":"A type that implements a live client to the "},{"type":"reference","identifier":"https:\/\/www.amiiboapi.org","isActive":true},{"type":"text","text":" online service."}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboLiveClient"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient","kind":"symbol","role":"symbol","title":"AmiiboLiveClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"},"https://www.amiiboapi.org":{"title":"Amiibo API","titleInlineContent":[{"type":"text","text":"Amiibo API"}],"type":"link","identifier":"https:\/\/www.amiiboapi.org","url":"https:\/\/www.amiiboapi.org"},"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"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/init(transport:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","text":"ClientTransport"},{"kind":"text","text":")"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient\/init(transport:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)","kind":"symbol","type":"topic","abstract":[{"text":"Initializes this client with a transport for performing HTTP operations.","type":"text"}],"title":"init(transport:)","role":"symbol"}}}