rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
2a7b9746a774ba216578062531d65ae32a4f53b6
discogs-service/docs/data/documentation/discogsservice/operations/getcollectionitemsbyfolder/output.json
T
javier 2a7b9746a7 Implemented the User Collection endpoints (#12) 
This PR contains the work done to implement the *User Collection* endpoints of the Discogs API into the `OpenAPI` specification document:

* GET `/users/{username}/collection/folders`
* POST `/users/{username}/collection/folders`
* GET `/users/{username}/collection/folders/{folder_id}`
* POST `/users/{username}/collection/folders/{folder_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}`
* GET `/users/{username}/collection/releases/{release_id}`
* GET `/users/{username}/collection/folders/{folder_id}/releases`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* GET `/users/{username}/collection/fields`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}/fields/{field_id}`
* GET `/users/{username}/collection/value`

Reviewed-on: #12
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-16 14:38:41 +00:00

1 line
17 KiB
JSON
Raw Blame History

{"metadata":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"symbolKind":"enum","modules":[{"name":"DiscogsService"}],"title":"Operations.GetCollectionItemsByFolder.Output","externalID":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"roleHeading":"Enumeration","role":"symbol"},"topicSections":[{"anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct"],"generated":true,"title":"Structures"},{"anchor":"Enumeration-Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/forbidden(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/internalServerError(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/ok(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/undocumented(statusCode:_:)"],"generated":true,"title":"Enumeration Cases"},{"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/forbidden","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/internalServerError","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/notFound","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/ok-swift.property"],"generated":true,"title":"Instance Properties"},{"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Equatable-Implementations"],"generated":true,"title":"Default Implementations"}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"platforms":["macOS"]}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/internalServerError(_:)":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/internalservererror(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/internalServerError(_:)","abstract":[{"text":"An Internal Server error was encountered.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"internalServerError"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses"},{"kind":"text","text":"."},{"text":"InternalError","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"type":"topic","title":"Operations.GetCollectionItemsByFolder.Output.internalServerError(_:)"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/forbidden":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/forbidden","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/forbidden","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".forbidden"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"NotAccessable","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","kind":"typeIdentifier"}],"title":"forbidden","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/undocumented(statusCode:_:)":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/undocumented(statuscode:_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/undocumented(statusCode:_:)","abstract":[{"type":"text","text":"Undocumented response."}],"kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"Operations.GetCollectionItemsByFolder.Output.undocumented(statusCode:_:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder","navigatorTitle":[{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","abstract":[{"text":"Get collection items of a user inside a specified folder.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCollectionItemsByFolder"}],"type":"topic","title":"Operations.GetCollectionItemsByFolder"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/notFound":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/notFound","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"notFound"},{"kind":"text","text":": "},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV","kind":"typeIdentifier","text":"NotFound"}],"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/notfound","role":"symbol","title":"notFound","type":"topic","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"type":"codeVoice","code":".notFound"},{"type":"text","text":"."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/forbidden(_:)":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/forbidden(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/forbidden(_:)","abstract":[{"type":"text","text":"A requested resource cannot be accessed due to a lack of permission."}],"kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","text":"NotAccessable","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"Operations.GetCollectionItemsByFolder.Output.forbidden(_:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/notFound(_:)":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"notFound"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotFound","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"},{"kind":"text","text":")"}],"title":"Operations.GetCollectionItemsByFolder.Output.notFound(_:)","abstract":[{"text":"A requested resource cannot be found.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/notFound(_:)","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/notfound(_:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"title":"Operations.GetCollectionItemsByFolder.Output","type":"topic"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/internalServerError":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV","text":"InternalError"}],"title":"internalServerError","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".internalServerError"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/internalServerError","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/internalservererror","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/ok(_:)":{"fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO2OkV"},{"text":")","kind":"text"}],"title":"Operations.GetCollectionItemsByFolder.Output.ok(_:)","abstract":[{"text":"Successfully retrieved a specific collection folder of a","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/ok(_:)","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/ok-swift.property":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","text":"GetCollectionItemsByFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO2OkV","text":"Ok"}],"title":"ok","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/ok-swift.property","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.property","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Equatable-Implementations","role":"collectionGroup","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/equatable-implementations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/Ok-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"title":"Operations.GetCollectionItemsByFolder.Output.Ok","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct"}}}
View Git Blame Copy Permalink