63118db805
This PR contains the work done to implement the *User Lists* endpoints of the *Discogs API* service in the `Open API` specification document:
* GET `/users/{username}/lists`
* GET `/lists/{list_id}`
Reviewed-on: #14
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
{"metadata":{"modules":[{"name":"DiscogsService"}],"extendedModule":"DiscogsService","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getUserSubmissions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","text":"GetUserSubmissions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","text":"GetUserSubmissions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","text":"GetUserSubmissions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO6OutputO","text":"Output","kind":"typeIdentifier"}],"role":"symbol","title":"getUserSubmissions(path:headers:)","externalID":"s:14DiscogsService11APIProtocolPAAE18getUserSubmissions4path7headersAA10OperationsO03GeteF0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV"},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/client\/getusersubmissions(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Get submissions of a user."}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getUserSubmissions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV4PathV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input\/Path-swift.struct","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV7HeadersV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input\/Headers-swift.struct","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Output","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Retrieves all the submissions or edits to releases, labels, and artist done by username.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"This endpoints accepts pagination headers.","type":"text"}]},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/users\/{username}\/submissions","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/users\/{username}\/submissions\/get(getUserSubmissions)","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"}],"kind":"content"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserSubmissions(path:headers:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions/Input/Headers-swift.struct":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"url":"\/documentation\/discogsservice\/operations\/getusersubmissions\/input\/headers-swift.struct","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"role":"symbol","kind":"symbol","title":"Operations.GetUserSubmissions.Input.Headers"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"role":"symbol","type":"topic","title":"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"}],"url":"\/documentation\/discogsservice\/operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions":{"kind":"symbol","navigatorTitle":[{"text":"GetUserSubmissions","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetUserSubmissions","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.GetUserSubmissions","abstract":[{"type":"text","text":"Get submissions of a user."}],"url":"\/documentation\/discogsservice\/operations\/getusersubmissions"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions/Input":{"url":"\/documentation\/discogsservice\/operations\/getusersubmissions\/input","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.GetUserSubmissions.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions/Output":{"kind":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.GetUserSubmissions.Output","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getusersubmissions\/output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserSubmissions/Input/Path-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserSubmissions\/Input\/Path-swift.struct","role":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"abstract":[],"title":"Operations.GetUserSubmissions.Input.Path","type":"topic","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getusersubmissions\/input\/path-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Client/getUserSubmissions(path:headers:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getUserSubmissions(path:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getUserSubmissions","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO5InputV7HeadersV","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":"GetUserSubmissions","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18GetUserSubmissionsO6OutputO","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"getUserSubmissions(path:headers:)","abstract":[{"text":"Get submissions of a user.","type":"text"}],"url":"\/documentation\/discogsservice\/client\/getusersubmissions(path:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"abstract":[{"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":"text"},{"inlineContent":[{"text":"Artists","type":"text"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"text":"Releases","type":"text"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"text":"Labels","type":"text"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"text":"Marketplace","type":"text"}]},{"type":"text","text":" listings, and more."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","url":"\/documentation\/discogsservice\/client"}}} |