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
15 KiB
JSON
1 line
15 KiB
JSON
{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"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\/masters\/{master_id}\/versions\/GET\/responses\/200\/headers"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"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"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Headers"}],"role":"symbol","title":"Operations.GetMasterVersions.Output.Ok.Headers","symbolKind":"struct","externalID":"s:14DiscogsService10OperationsO17GetMasterVersionsO6OutputO2OkV7HeadersV","roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/init(link:xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)"],"title":"Initializers","anchor":"Initializers","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/link","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimit","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitRemaining","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitUsed"],"title":"Instance Properties","anchor":"Instance-Properties","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/Equatable-Implementations"],"title":"Default Implementations","anchor":"Default-Implementations","generated":true}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct/Headers-swift.struct/Equatable-Implementations":{"type":"topic","kind":"article","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/Equatable-Implementations","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct\/equatable-implementations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct/Headers-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetMasterVersions.Output.Ok.Headers","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct","role":"symbol"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"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/GetMasterVersions/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimitRemaining":{"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","kind":"symbol","role":"symbol","title":"xDiscogsRateLimitRemaining","abstract":[{"text":"A number of remaining requests that can be made in an existing rate limit window.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitRemaining","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimitremaining"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetMasterVersions"}],"navigatorTitle":[{"kind":"identifier","text":"GetMasterVersions"}],"abstract":[{"text":"Get information about the versions of a master release.","type":"text"}],"kind":"symbol","type":"topic","title":"Operations.GetMasterVersions","url":"\/documentation\/discogsservice\/operations\/getmasterversions","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimit":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/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"}],"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/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/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output":{"navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","title":"Operations.GetMasterVersions.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","role":"symbol","abstract":[]},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetMasterVersions.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Output/Ok-swift.struct/Headers-swift.struct/link":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","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":"Link","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO4Linka"}],"type":"topic","kind":"symbol","role":"symbol","title":"link","abstract":[{"text":"Contains URLs for pagination, compliant with RFC 5988.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/link","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct\/link"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/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"},{"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"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimitused","title":"xDiscogsRateLimitUsed","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitUsed","abstract":[{"text":"A number of requests that have been made in an existing rate limit window.","type":"text"}],"role":"symbol"},"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/GetMasterVersions/Output/Ok-swift.struct/Headers-swift.struct/init(link:xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"link","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":"Link","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO4Linka"},{"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"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/output\/ok-swift.struct\/headers-swift.struct\/init(link:xdiscogsratelimit:xdiscogsratelimitused:xdiscogsratelimitremaining:)","title":"init(link:xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Output\/Ok-swift.struct\/Headers-swift.struct\/init(link:xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"Headers","type":"codeVoice"},{"type":"text","text":"."}],"role":"symbol"}}} |