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

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"kind":"symbol","abstract":[{"text":"Get all the collection folders of a user.","type":"text"}],"metadata":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionFolders","kind":"identifier"}],"role":"symbol","title":"Operations.GetCollectionFolders","navigatorTitle":[{"kind":"identifier","text":"GetCollectionFolders"}],"symbolKind":"enum","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","roleHeading":"Enumeration"},"topicSections":[{"anchor":"Structures","title":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input"],"generated":true},{"anchor":"Type-Properties","title":"Type Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/id"],"generated":true},{"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output"],"generated":true}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCollectionFolders"}],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"overview","text":"Overview","type":"heading","level":2},{"inlineContent":[{"text":"Retrieves a list of folders in a collection of a user.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"In case the collection has been made private by its owner, authentication as the collection owner is required. Otherwise, only folder "},{"type":"codeVoice","code":"ID 0"},{"type":"text","text":" (the “All” folder) will be visible only if the requested collection of a user is public."}],"type":"paragraph"},{"style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"type":"codeVoice","code":"GET \/users\/{username}\/collection\/folders"},{"text":".","type":"text"}]}],"type":"aside"},{"style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/folders\/get(getCollectionFolders)","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside"}]}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionfolders"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"GetCollectionFolders","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders","abstract":[{"type":"text","text":"Get all the collection folders of a user."}],"type":"topic","title":"Operations.GetCollectionFolders","navigatorTitle":[{"text":"GetCollectionFolders","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/id":{"type":"topic","title":"id","abstract":[],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/id","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/id","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Input":{"url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"abstract":[],"title":"Operations.GetCollectionFolders.Input","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input","role":"symbol"},"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":{"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/GetCollectionFolders/Output":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output","kind":"symbol","role":"symbol","type":"topic","title":"Operations.GetCollectionFolders.Output","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/AcceptableContentType":{"abstract":[],"navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/AcceptableContentType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AcceptableContentType","kind":"identifier"}],"kind":"symbol","title":"Operations.GetCollectionFolders.AcceptableContentType","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/acceptablecontenttype","type":"topic"}}}