rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/client/putreleaseratingbyuser(path:query:headers:).json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 15:20:20 +00:00

1 line
18 KiB
JSON
Raw Blame History

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/putReleaseRatingByUser(path:query:headers:)"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"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":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO6OutputO","text":"Output"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"type":"paragraph","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":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"PUT \/releases\/{release_id}\/rating\/{username}"},{"type":"text","text":"."}]}],"style":"note"},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/releases\/{release_id}\/rating\/{username}\/put(putReleaseRatingByUser)"},{"type":"text","text":"."}]}],"style":"note"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/putreleaseratingbyuser(path:query:headers:)"]}],"abstract":[{"type":"text","text":"Update information about a rating of release by a user."}],"metadata":{"role":"symbol","title":"putReleaseRatingByUser(path:query:headers:)","externalID":"s:14DiscogsService11APIProtocolPAAE22putReleaseRatingByUser4path5query7headersAA10OperationsO03PutefgH0O6OutputOAK5InputV4PathV_AO5QueryVAO7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","modules":[{"name":"DiscogsService"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"putReleaseRatingByUser","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV7HeadersV","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:14DiscogsService10OperationsO22PutReleaseRatingByUserO","text":"PutReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO6OutputO","text":"Output","kind":"typeIdentifier"}],"symbolKind":"method","extendedModule":"DiscogsService"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Client/putReleaseRatingByUser(path:query:headers:)":{"url":"\/documentation\/discogsservice\/client\/putreleaseratingbyuser(path:query:headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"putReleaseRatingByUser","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","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":"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","preciseIdentifier":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO6OutputO","kind":"typeIdentifier"}],"title":"putReleaseRatingByUser(path:query:headers:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/putReleaseRatingByUser(path:query:headers:)","abstract":[{"type":"text","text":"Update information about a rating of release by a user."}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser":{"type":"topic","abstract":[{"type":"text","text":"Update information about a rating of release by a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","title":"Operations.PutReleaseRatingByUser","navigatorTitle":[{"kind":"identifier","text":"PutReleaseRatingByUser"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PutReleaseRatingByUser"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Path-swift.struct":{"abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Path"}],"title":"Operations.PutReleaseRatingByUser.Input.Path","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/path-swift.struct","role":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Headers-swift.struct":{"abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"title":"Operations.PutReleaseRatingByUser.Input.Headers","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/headers-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Client"}],"navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","url":"\/documentation\/discogsservice\/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"}]},{"text":", ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"text":". Your application can also manage ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"text":" and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Wantlists"}]},{"text":", create ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"text":" listings, and more.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input":{"type":"topic","title":"Operations.PutReleaseRatingByUser.Input","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Query-swift.struct":{"abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"title":"Operations.PutReleaseRatingByUser.Input.Query","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/query-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Query-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Output":{"type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Output","title":"Operations.PutReleaseRatingByUser.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/output","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","title":"Operations","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}]}}}
View Git Blame Copy Permalink