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
15 KiB
JSON
1 line
15 KiB
JSON
{"metadata":{"modules":[{"name":"DiscogsService"}],"extendedModule":"DiscogsService","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getReleaseRatingByUser","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","text":"GetReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV4PathV","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:14DiscogsService10OperationsO22GetReleaseRatingByUserO","text":"GetReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV7HeadersV","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:14DiscogsService10OperationsO22GetReleaseRatingByUserO","text":"GetReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","text":"Output","kind":"typeIdentifier"}],"role":"symbol","title":"getReleaseRatingByUser(path:headers:)","externalID":"s:14DiscogsService11APIProtocolPAAE22getReleaseRatingByUser4path7headersAA10OperationsO03GetefgH0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV"},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/client\/getreleaseratingbyuser(path:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Get information about a rating of release by a user.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getReleaseRatingByUser","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV4PathV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV7HeadersV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"inlineContent":[{"text":"Retrieves the rating for a given release by a specific user.","type":"text"}],"type":"paragraph"},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/releases\/{release_id}\/rating\/{username}","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/releases\/{release_id}\/rating\/{username}\/get(getReleaseRatingByUser)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getReleaseRatingByUser(path:headers:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Output":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/output","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.GetReleaseRatingByUser.Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input":{"kind":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.GetReleaseRatingByUser.Input","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input"},"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/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"},"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/Client/getReleaseRatingByUser(path:headers:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getReleaseRatingByUser(path:headers:)","role":"symbol","abstract":[{"text":"Get information about a rating of release by a user.","type":"text"}],"title":"getReleaseRatingByUser(path:headers:)","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getReleaseRatingByUser","kind":"identifier"},{"kind":"text","text":"("},{"text":"path","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV4PathV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV7HeadersV","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:14DiscogsService10OperationsO22GetReleaseRatingByUserO","text":"GetReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","text":"Output","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/client\/getreleaseratingbyuser(path:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input/Headers-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.GetReleaseRatingByUser.Input.Headers","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser":{"kind":"symbol","navigatorTitle":[{"text":"GetReleaseRatingByUser","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseRatingByUser","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.GetReleaseRatingByUser","abstract":[{"type":"text","text":"Get information about a rating of release by a user."}],"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input/Path-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/path-swift.struct","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Path-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Path"}],"title":"Operations.GetReleaseRatingByUser.Input.Path"}}} |