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.4 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output"]]},"kind":"symbol","sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/forbidden"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".forbidden","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"externalID":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO9forbiddenAA10ComponentsO9ResponsesO13NotAccessableVvp","title":"forbidden","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"forbidden"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"text":".","kind":"text"},{"text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"NotAccessable","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"DiscogsService"}]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/forbidden","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotAccessable","text":"NotAccessable","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".forbidden"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Throws"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".forbidden"},{"type":"text","text":"."}]}],"style":"note","name":"See Also"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder","navigatorTitle":[{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"abstract":[{"type":"text","text":"Get collection items of a user inside a specified folder."}],"title":"Operations.GetCollectionItemsByFolder","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","role":"symbol"},"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/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/Operations/GetCollectionItemsByFolder/Output/forbidden":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","text":"NotAccessable","kind":"typeIdentifier"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".forbidden"},{"text":".","type":"text"}],"title":"forbidden","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/forbidden","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/forbidden"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotAccessable":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NotAccessable","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/components\/responses\/notaccessable","type":"topic","title":"Components.Responses.NotAccessable","abstract":[],"navigatorTitle":[{"text":"NotAccessable","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotAccessable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","type":"topic","role":"symbol","kind":"symbol","abstract":[],"title":"Operations.GetCollectionItemsByFolder.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output"},"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"},"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."}]}}}