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

{"metadata":{"roleHeading":"Initializer","externalID":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc","modules":[{"name":"DiscogsService"}],"title":"init(headers:body:)","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":"GetStatistics","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO"},{"kind":"text","text":"."},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetStatistics","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"role":"symbol"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetStatistics","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV7HeadersV","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics","text":"GetStatistics","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct\/Body-swift.enum","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV4BodyO","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"name":"headers","content":[{"inlineContent":[{"text":"Received HTTP response headers","type":"text"}],"type":"paragraph"}]},{"name":"body","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Received HTTP response body"}]}]}],"kind":"parameters"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getstatistics\/output\/ok-swift.struct\/init(headers:body:)"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct\/init(headers:body:)","interfaceLanguage":"swift"},"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetStatistics/Output/Ok-swift.struct/Headers-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"abstract":[],"title":"Operations.GetStatistics.Output.Ok.Headers","type":"topic","url":"\/documentation\/discogsservice\/operations\/getstatistics\/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/GetStatistics/Output/Ok-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.GetStatistics.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getstatistics\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetStatistics/Output/Ok-swift.struct/Body-swift.enum":{"type":"topic","navigatorTitle":[{"text":"Body","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct\/Body-swift.enum","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Body"}],"kind":"symbol","title":"Operations.GetStatistics.Output.Ok.Body","url":"\/documentation\/discogsservice\/operations\/getstatistics\/output\/ok-swift.struct\/body-swift.enum","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetStatistics/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Output"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.GetStatistics.Output","url":"\/documentation\/discogsservice\/operations\/getstatistics\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetStatistics/Output/Ok-swift.struct/init(headers:body:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics\/Output\/Ok-swift.struct\/init(headers:body:)","title":"init(headers:body:)","type":"topic","url":"\/documentation\/discogsservice\/operations\/getstatistics\/output\/ok-swift.struct\/init(headers:body:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"Ok","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO","kind":"typeIdentifier","text":"GetStatistics"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"text":"GetStatistics","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13GetStatisticsO6OutputO2OkV4BodyO","text":"Body"},{"kind":"text","text":")"}]},"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/GetStatistics":{"url":"\/documentation\/discogsservice\/operations\/getstatistics","abstract":[{"text":"Get some statistics of a release.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"GetStatistics"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetStatistics"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetStatistics","kind":"symbol","type":"topic","title":"Operations.GetStatistics"}}}