f3d5c0e6ac
This PR contains the work done to implement the *User Wantlist* endpoints of the *Discogs API* online service in the `Open API` specification document:
* GET `/users/{username}/wants`
* POST `/users/{username}/wants/{release_id}`
* PUT `/users/{username}/wants/{release_id}`
* DELETE `/users/{username}/wants/{release_id}`
Reviewed-on: #13
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":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getUserSubmissions"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","text":"GetUserSubmissions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","text":"GetUserSubmissions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO6OutputO","text":"Output"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"inlineContent":[{"type":"text","text":"Retrieves all the submissions or edits to releases, labels, and artist done by username."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoints accepts pagination headers."}],"type":"paragraph"},{"content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/users\/{username}\/submissions","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Remark","style":"note","type":"aside"},{"content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/submissions\/get(getUserSubmissions)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Remark","style":"note","type":"aside"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"metadata":{"symbolKind":"method","title":"getUserSubmissions(_:)","roleHeading":"Instance Method","modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService6ClientV18getUserSubmissionsyAA10OperationsO03GeteF0O6OutputOAH5InputVYaKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getUserSubmissions"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","text":"GetUserSubmissions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","text":"GetUserSubmissions"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO6OutputO","text":"Output"}]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserSubmissions(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Get submissions of a user."}],"seeAlsoSections":[{"generated":true,"title":"User Identity","anchor":"User-Identity","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserProfile(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/postUserProfile(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserContributions(_:)"]}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/getusersubmissions(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions":{"title":"Operations.GetUserSubmissions","navigatorTitle":[{"text":"GetUserSubmissions","kind":"identifier"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Get submissions of a user."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetUserSubmissions","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions","url":"\/documentation\/discogsservice\/operations\/getusersubmissions"},"doc://DiscogsService/documentation/DiscogsService/Client/getUserSubmissions(_:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserSubmissions(_:)","role":"symbol","abstract":[{"text":"Get submissions of a user.","type":"text"}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getUserSubmissions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetUserSubmissions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetUserSubmissions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO6OutputO"}],"title":"getUserSubmissions(_:)","url":"\/documentation\/discogsservice\/client\/getusersubmissions(_:)"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","type":"topic","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[],"kind":"symbol","role":"collection"},"doc://DiscogsService/documentation/DiscogsService/Client/getUserProfile(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserProfile(_:)","kind":"symbol","role":"symbol","abstract":[{"text":"Get information about a user.","type":"text"}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getUserProfile","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO"}],"title":"getUserProfile(_:)","url":"\/documentation\/discogsservice\/client\/getuserprofile(_:)"},"doc://DiscogsService/documentation/DiscogsService/Client/postUserProfile(_:)":{"url":"\/documentation\/discogsservice\/client\/postuserprofile(_:)","type":"topic","abstract":[{"text":"Update information about a user.","type":"text"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"postUserProfile","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","text":"PostUserProfile","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO"}],"kind":"symbol","title":"postUserProfile(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/postUserProfile(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions/Input":{"title":"Operations.GetUserSubmissions.Input","url":"\/documentation\/discogsservice\/operations\/getusersubmissions\/input","abstract":[],"role":"symbol","type":"topic","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions/Output":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getusersubmissions\/output","title":"Operations.GetUserSubmissions.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Output","abstract":[],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"abstract":[{"type":"text","text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"type":"text","text":", and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"type":"text","text":". Your application can also manage "},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Wantlists"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"url":"\/documentation\/discogsservice\/client","title":"Client","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client/getUserContributions(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserContributions(_:)","kind":"symbol","role":"symbol","abstract":[{"text":"Get contributions of a user.","type":"text"}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getUserContributions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"text":"GetUserContributions","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO20GetUserContributionsO"},{"kind":"text","text":"."},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO20GetUserContributionsO5InputV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetUserContributions","preciseIdentifier":"s:14DiscogsService10OperationsO20GetUserContributionsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO20GetUserContributionsO6OutputO"}],"title":"getUserContributions(_:)","url":"\/documentation\/discogsservice\/client\/getusercontributions(_:)"}}} |