Files
javier eaee2b84f0 Documentation update (#17)
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>
2026-03-24 01:54:43 +00:00

1 line
7.6 KiB
JSON

{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"kind":"text","text":"("},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","text":"GetReleaseRatingByUser","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO2OkV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output\/Ok-swift.struct"},{"text":")","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"style":"note","name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/releases\/{release_id}\/rating\/{username}\/get(getReleaseRatingByUser)\/responses\/200","type":"codeVoice"},{"text":".","type":"text"}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP response code: "},{"type":"codeVoice","code":"200 ok"},{"type":"text","text":"."}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output\/ok(_:)"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/output\/ok(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Successfully retrieved release rating details by a given user."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output"]]},"metadata":{"symbolKind":"case","title":"Operations.GetReleaseRatingByUser.Output.ok(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"ok","kind":"identifier"},{"kind":"text","text":"("},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","text":"Output"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO2OkV"},{"kind":"text","text":")"}],"externalID":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO2okyA2G2OkVcAGmF","roleHeading":"Case","modules":[{"name":"DiscogsService"}]},"references":{"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/GetReleaseRatingByUser/Output/Ok-swift.struct":{"role":"symbol","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output\/Ok-swift.struct","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/output\/ok-swift.struct","abstract":[],"type":"topic","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Ok"}],"title":"Operations.GetReleaseRatingByUser.Output.Ok"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Output/ok(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output\/ok(_:)","title":"Operations.GetReleaseRatingByUser.Output.ok(_:)","type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/output\/ok(_:)","abstract":[{"type":"text","text":"Successfully retrieved release rating details by a given user."}],"kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","text":"GetReleaseRatingByUser","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO2OkV"},{"kind":"text","text":")"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Output":{"title":"Operations.GetReleaseRatingByUser.Output","type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/output","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser":{"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","title":"Operations.GetReleaseRatingByUser","abstract":[{"type":"text","text":"Get information about the rating of a release by a user."}],"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseRatingByUser","kind":"identifier"}],"navigatorTitle":[{"text":"GetReleaseRatingByUser","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"}}}