Files
discogs-service/docs/data/documentation/discogsservice/operations/getcollectionitemsbyfolder.json
T
javier f3d5c0e6ac Implemented the User Wantlist endpoints (#13)
This PR contains the work done to implement the *User Wantlist* endpoints of the *Discogs API* online service in the `Open API` specification document:

* GET `/users/{username}/wants`
* POST `/users/{username}/wants/{release_id}`
* PUT `/users/{username}/wants/{release_id}`
* DELETE `/users/{username}/wants/{release_id}`

Reviewed-on: #13
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-16 16:24:46 +00:00

1 line
7.3 KiB
JSON

{"abstract":[{"text":"Get collection items of a user inside a specified folder.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"overview","text":"Overview"},{"inlineContent":[{"text":"Returns the list of item in a specified collection folder of a user.","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release."}]},{"inlineContent":[{"text":"This endpoint provides pagination parameters and also, requires authentication as an owner of a collection only in case the ","type":"text"},{"code":"folder_id","type":"codeVoice"},{"text":" is not ","type":"text"},{"code":"0","type":"codeVoice"},{"text":", or the collection has been made private by its owner. Otherwise, only public notes fields will be visible.","type":"text"}],"type":"paragraph"},{"content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/users\/{username}\/collection\/folders\/{folder_id}\/releases","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"},{"name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/get(getCollectionItemsByFolder)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"sections":[],"topicSections":[{"title":"Structures","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input"],"anchor":"Structures"},{"title":"Type Properties","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/id"],"anchor":"Type-Properties"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output"],"title":"Enumerations","anchor":"Enumerations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"navigatorTitle":[{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"externalID":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","title":"Operations.GetCollectionItemsByFolder","roleHeading":"Enumeration","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"symbolKind":"enum","role":"symbol"},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/AcceptableContentType":{"navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/acceptablecontenttype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"title":"Operations.GetCollectionItemsByFolder.AcceptableContentType","abstract":[],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/AcceptableContentType","type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","type":"topic","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[],"kind":"symbol","role":"collection"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output":{"title":"Operations.GetCollectionItemsByFolder.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder":{"navigatorTitle":[{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"title":"Operations.GetCollectionItemsByFolder","abstract":[{"type":"text","text":"Get collection items of a user inside a specified folder."}],"role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/id":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/id","abstract":[],"title":"id","type":"topic","kind":"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\/GetCollectionItemsByFolder\/id","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"title":"Operations.GetCollectionItemsByFolder.Input","abstract":[],"role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input"}}}