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
12 KiB
JSON

{"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","kind":"typeIdentifier","text":"GetArtist"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":", "},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Body-swift.enum"},{"text":")","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Received HTTP response headers","type":"text"}]}]},{"name":"body","content":[{"type":"paragraph","inlineContent":[{"text":"Received HTTP response body","type":"text"}]}]}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/init(headers:body:)"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/init(headers:body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"roleHeading":"Initializer","title":"init(headers:body:)","externalID":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO"},{"kind":"text","text":")"}],"role":"symbol","modules":[{"name":"DiscogsService"}]},"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetArtist"}],"kind":"symbol","role":"symbol","type":"topic","title":"Operations.GetArtist","abstract":[{"type":"text","text":"Get information about an artist."}],"url":"\/documentation\/discogsservice\/operations\/getartist","navigatorTitle":[{"kind":"identifier","text":"GetArtist"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist"},"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/Operations/GetArtist/Output/Ok-swift.struct/init(headers:body:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/init(headers:body:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"type":"topic","title":"init(headers:body:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","kind":"typeIdentifier","text":"GetArtist"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO","kind":"typeIdentifier","text":"Body"},{"kind":"text","text":")"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/init(headers:body:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/Headers-swift.struct":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Headers"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Headers-swift.struct","abstract":[],"title":"Operations.GetArtist.Output.Ok.Headers","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"abstract":[],"title":"Operations.GetArtist.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/Body-swift.enum":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Body-swift.enum","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/body-swift.enum","navigatorTitle":[{"kind":"identifier","text":"Body"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetArtist.Output.Ok.Body"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output":{"title":"Operations.GetArtist.Output","type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","kind":"symbol","abstract":[],"role":"symbol"}}}