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