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