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
18 KiB
JSON
1 line
18 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"putReleaseRatingByUser"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PutReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PutReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV7HeadersV"},{"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":"PutReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO6OutputO"}],"roleHeading":"Instance Method","externalID":"s:14DiscogsService11APIProtocolPAAE22putReleaseRatingByUser4path5query7headersAA10OperationsO03PutefgH0O6OutputOAK5InputV4PathV_AO5QueryVAO7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","title":"putReleaseRatingByUser(path:query:headers:)","modules":[{"name":"DiscogsService"}],"role":"symbol","symbolKind":"method","extendedModule":"DiscogsService"},"abstract":[{"type":"text","text":"Update information about the rating of a release by a user."}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"putReleaseRatingByUser"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","kind":"typeIdentifier","text":"PutReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct","kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","kind":"typeIdentifier","text":"PutReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct","kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV5QueryV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","kind":"typeIdentifier","text":"PutReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Headers-swift.struct","kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV7HeadersV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PutReleaseRatingByUser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO6OutputO"}]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"inlineContent":[{"type":"text","text":"Updates a rating of a release for a given user."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoint requires authentication."}],"type":"paragraph"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"PUT \/releases\/{release_id}\/rating\/{username}"},{"type":"text","text":"."}]}],"type":"aside","style":"note"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/releases\/{release_id}\/rating\/{username}\/put(putReleaseRatingByUser)","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/putreleaseratingbyuser(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/putReleaseRatingByUser(path:query:headers:)","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/output","abstract":[],"type":"topic","title":"Operations.PutReleaseRatingByUser.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser":{"abstract":[{"text":"Update information about the rating of a release by a user.","type":"text"}],"url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PutReleaseRatingByUser","kind":"identifier"}],"navigatorTitle":[{"text":"PutReleaseRatingByUser","kind":"identifier"}],"role":"symbol","title":"Operations.PutReleaseRatingByUser","type":"topic"},"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/Operations/PutReleaseRatingByUser/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.PutReleaseRatingByUser.Input","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Query-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct","kind":"symbol","role":"symbol","type":"topic","title":"Operations.PutReleaseRatingByUser.Input.Query","abstract":[],"url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}]},"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/Client/putReleaseRatingByUser(path:query:headers:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"putReleaseRatingByUser"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","kind":"typeIdentifier","text":"PutReleaseRatingByUser"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PutReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PutReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV7HeadersV"},{"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":"PutReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO6OutputO"}],"title":"putReleaseRatingByUser(path:query:headers:)","url":"\/documentation\/discogsservice\/client\/putreleaseratingbyuser(path:query:headers:)","abstract":[{"type":"text","text":"Update information about the rating of a release by a user."}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/putReleaseRatingByUser(path:query:headers:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Headers-swift.struct":{"title":"Operations.PutReleaseRatingByUser.Input.Headers","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Headers-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"abstract":[],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/headers-swift.struct"},"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/Operations/PutReleaseRatingByUser/Input/Path-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct","abstract":[],"type":"topic","title":"Operations.PutReleaseRatingByUser.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/path-swift.struct","navigatorTitle":[{"text":"Path","kind":"identifier"}]}}} |