rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
67c9ffa6f4a0d32e64433c5708d320fccd64efe5
discogs-service/docs/data/documentation/discogsservice/operations/getcollectionfolder/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

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