eaee2b84f0
This PR contains the work done to update the overall documentation of the package. Reviewed-on: #17 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":{"externalID":"s:14DiscogsService6ClientV16updateInWantlistyAA10OperationsO06UpdateeF0O6OutputOAH5InputVYaKF","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updateInWantlist"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO","kind":"typeIdentifier","text":"UpdateInWantlist"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO5InputV"},{"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":"UpdateInWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO6OutputO"}],"modules":[{"name":"DiscogsService"}],"roleHeading":"Instance Method","title":"updateInWantlist(_:)"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updateInWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/UpdateInWantlist"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO5InputV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/UpdateInWantlist\/Input"},{"text":") ","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"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO","text":"UpdateInWantlist"},{"kind":"text","text":"."},{"text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/UpdateInWantlist\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO6OutputO"}]}]},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"Modifies some metadata associated with a release in a wantlist of a user.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"This endpoint requires authentication as the wantlist owner.","type":"text"}]},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"POST \/users\/{username}\/wants\/{release_id}"},{"type":"text","text":"."}],"type":"paragraph"}]},{"style":"note","name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/users\/{username}\/wants\/{release_id}\/post(updateInWantlist)","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"kind":"symbol","seeAlsoSections":[{"title":"User Wantlist","anchor":"User-Wantlist","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)"]}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/updateinwantlist(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)"},"abstract":[{"type":"text","text":"Update a release in a wantlist of a user."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/UpdateInWantlist/Input":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/UpdateInWantlist\/Input","kind":"symbol","role":"symbol","type":"topic","title":"Operations.UpdateInWantlist.Input","abstract":[],"url":"\/documentation\/discogsservice\/operations\/updateinwantlist\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"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"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"title":"Client","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/UpdateInWantlist":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"UpdateInWantlist"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"UpdateInWantlist"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Update a release in a wantlist of a user."}],"title":"Operations.UpdateInWantlist","url":"\/documentation\/discogsservice\/operations\/updateinwantlist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/UpdateInWantlist"},"doc://DiscogsService/documentation/DiscogsService/Client/getWantlist(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)","abstract":[{"type":"text","text":"Get a list of releases in a wantlist of a user."}],"type":"topic","title":"getWantlist(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO","text":"GetWantlist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV","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:14DiscogsService10OperationsO11GetWantlistO","text":"GetWantlist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO","text":"Output"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/client\/getwantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Client/addToWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/addtowantlist(_:)","title":"addToWantlist(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"addToWantlist","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO","kind":"typeIdentifier","text":"AddToWantlist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"text":"AddToWantlist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO6OutputO"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)","kind":"symbol","abstract":[{"type":"text","text":"Add a release into a wantlist of a user."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/UpdateInWantlist/Output":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/UpdateInWantlist\/Output","title":"Operations.UpdateInWantlist.Output","url":"\/documentation\/discogsservice\/operations\/updateinwantlist\/output","type":"topic","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Client/updateInWantlist(_:)":{"type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updateInWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO5InputV","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":"UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO6OutputO","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"text":"Update a release in a wantlist of a user.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)","url":"\/documentation\/discogsservice\/client\/updateinwantlist(_:)","title":"updateInWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService/Client/deleteFromWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/deletefromwantlist(_:)","abstract":[{"text":"Delete a release from a wantlist of a user.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteFromWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO","text":"DeleteFromWantlist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV","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:14DiscogsService10OperationsO18DeleteFromWantlistO","text":"DeleteFromWantlist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO6OutputO","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)","kind":"symbol","type":"topic","title":"deleteFromWantlist(_:)"}}} |