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