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

{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"metadata":{"roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"title":"Operations.GetCollectionFolder.Output.Ok","symbolKind":"struct"},"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/Headers-swift.struct"],"title":"Structures","generated":true},{"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/init(headers:body:)"],"title":"Initializers","generated":true},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/body-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/headers-swift.property"],"generated":true,"anchor":"Instance-Properties"},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/Body-swift.enum"],"generated":true,"anchor":"Enumerations"},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output"]]},"relationshipsSections":[{"type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To"}],"references":{"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolder/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output","type":"topic","title":"Operations.GetCollectionFolder.Output","abstract":[],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolder/Output/Ok-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct","title":"Operations.GetCollectionFolder.Output.Ok","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}]},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolder/Output/Ok-swift.struct/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/Equatable-Implementations","abstract":[],"type":"topic","title":"Equatable Implementations","kind":"article","role":"collectionGroup","url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct\/equatable-implementations"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"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/GetCollectionFolder":{"url":"\/documentation\/discogsservice\/operations\/getcollectionfolder","navigatorTitle":[{"kind":"identifier","text":"GetCollectionFolder"}],"abstract":[{"type":"text","text":"Get information about a collection folder of a user."}],"title":"Operations.GetCollectionFolder","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"GetCollectionFolder","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolder/Output/Ok-swift.struct/body-swift.property":{"type":"topic","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/body-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO","kind":"typeIdentifier","text":"GetCollectionFolder"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV4BodyO","kind":"typeIdentifier","text":"Body"}],"kind":"symbol","title":"body","url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct\/body-swift.property","abstract":[{"text":"Received HTTP response body","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolder/Output/Ok-swift.struct/init(headers:body:)":{"url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct\/init(headers:body:)","kind":"symbol","role":"symbol","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"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO","text":"GetCollectionFolder","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO","text":"GetCollectionFolder","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/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:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolder/Output/Ok-swift.struct/Body-swift.enum":{"url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct\/body-swift.enum","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Body"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/Body-swift.enum","title":"Operations.GetCollectionFolder.Output.Ok.Body"},"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/GetCollectionFolder/Output/Ok-swift.struct/headers-swift.property":{"abstract":[{"type":"text","text":"Received HTTP response headers"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/headers-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO","text":"GetCollectionFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO19GetCollectionFolderO6OutputO2OkV7HeadersV","text":"Headers"}],"kind":"symbol","title":"headers","url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct\/headers-swift.property","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolder/Output/Ok-swift.struct/Headers-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolder\/Output\/Ok-swift.struct\/Headers-swift.struct","title":"Operations.GetCollectionFolder.Output.Ok.Headers","url":"\/documentation\/discogsservice\/operations\/getcollectionfolder\/output\/ok-swift.struct\/headers-swift.struct","type":"topic","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}]}}}