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