rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
298911a554d2df14d747bba1f648cb5a7df9af06
discogs-service/docs/data/documentation/discogsservice/operations/getcollectionitemsbyfolder/output/ok-swift.struct/headers-swift.struct.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
14 KiB
JSON
Raw Blame History

{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct\/headers-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"Operations.GetCollectionItemsByFolder.Output.Ok.Headers","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO2OkV7HeadersV","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"symbolKind":"struct"},"topicSections":[{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)"]},{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimit","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitRemaining","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitUsed"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/Equatable-Implementations"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/GET\/responses\/200\/headers","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct","interfaceLanguage":"swift"},"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"kind":"symbol","references":{"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/Ok-swift.struct/Headers-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct\/headers-swift.struct","title":"Operations.GetCollectionItemsByFolder.Output.Ok.Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct","abstract":[],"role":"symbol"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimit":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"xDiscogsRateLimit","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO"},{"text":".","kind":"text"},{"text":"RateLimit","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO9RateLimita"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimit","title":"xDiscogsRateLimit","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimit","abstract":[{"type":"text","text":"A total number of requests that can be made in a minute window."}],"role":"symbol"},"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/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"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/Ok-swift.struct/Headers-swift.struct/Equatable-Implementations":{"abstract":[],"title":"Equatable Implementations","role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/Equatable-Implementations","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct\/headers-swift.struct\/equatable-implementations","type":"topic","kind":"article"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimitRemaining":{"type":"topic","title":"xDiscogsRateLimitRemaining","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitRemaining","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimitremaining","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"xDiscogsRateLimitRemaining"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"RateLimitRemaining","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO18RateLimitRemaininga"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A number of remaining requests that can be made in an existing rate limit window.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/Ok-swift.struct/Headers-swift.struct/init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Headers","type":"codeVoice"},{"text":".","type":"text"}],"title":"init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"xDiscogsRateLimit","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO"},{"text":".","kind":"text"},{"text":"RateLimit","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO9RateLimita"},{"text":", ","kind":"text"},{"text":"xDiscogsRateLimitUsed","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO"},{"text":".","kind":"text"},{"text":"RateLimitUsed","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO13RateLimitUseda"},{"text":", ","kind":"text"},{"text":"xDiscogsRateLimitRemaining","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO"},{"text":".","kind":"text"},{"text":"RateLimitRemaining","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO18RateLimitRemaininga"},{"text":")","kind":"text"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct\/headers-swift.struct\/init(xdiscogsratelimit:xdiscogsratelimitused:xdiscogsratelimitremaining:)","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimitUsed":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"xDiscogsRateLimitUsed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO","text":"Headers"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO13RateLimitUseda","text":"RateLimitUsed"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimitused","title":"xDiscogsRateLimitUsed","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitUsed","abstract":[{"type":"text","text":"A number of requests that have been made in an existing rate limit window."}],"role":"symbol"},"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"}}}
View Git Blame Copy Permalink