Files
javier eaee2b84f0 Documentation update (#17)
This PR contains the work done to update the overall documentation of the package.

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

1 line
8.3 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"},{"text":".","kind":"text"},{"text":"ServiceError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["macOS"]}]},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"style":"note","name":"Throws","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is not "},{"code":".json","type":"codeVoice"},{"type":"text","text":"."}]}]},{"style":"note","type":"aside","name":"See Also","content":[{"inlineContent":[{"text":"","type":"text"},{"code":".json","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"metadata":{"roleHeading":"Instance Property","externalID":"s:14DiscogsService10ComponentsO9ResponsesO11UnavailableV4BodyO4jsonAC7SchemasO0B5ErrorVvp","modules":[{"name":"DiscogsService"}],"title":"json","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"json","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ServiceError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV"}],"role":"symbol"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/components\/responses\/unavailable\/body-swift.enum\/json"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum\/json"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum"]]},"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".json","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/Unavailable":{"abstract":[],"url":"\/documentation\/discogsservice\/components\/responses\/unavailable","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Unavailable","kind":"identifier"}],"navigatorTitle":[{"text":"Unavailable","kind":"identifier"}],"role":"symbol","title":"Components.Responses.Unavailable","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/Unavailable/Body-swift.enum/json":{"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".json"},{"type":"text","text":"."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum\/json","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"ServiceError","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV","kind":"typeIdentifier"}],"title":"json","type":"topic","url":"\/documentation\/discogsservice\/components\/responses\/unavailable\/body-swift.enum\/json","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/Unavailable/Body-swift.enum":{"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"navigatorTitle":[{"text":"Body","kind":"identifier"}],"title":"Components.Responses.Unavailable.Body","kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/responses\/unavailable\/body-swift.enum"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ServiceError":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ServiceError"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError","type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A type that contains any error data."}],"title":"Components.Schemas.ServiceError","navigatorTitle":[{"kind":"identifier","text":"ServiceError"}],"url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Responses","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"Components.Responses","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/responses","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"url":"\/documentation\/discogsservice\/components\/responses","type":"topic","navigatorTitle":[{"text":"Responses","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses"}}}