Files
T
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
8.6 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Query-swift.struct"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"rating"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier","text":"Parameters"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Rating","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO6Ratinga","kind":"typeIdentifier","text":"Rating"},{"kind":"text","text":"? = nil)"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"A number for a rating of a release.","type":"text"}],"type":"paragraph"}],"name":"rating"}],"kind":"parameters"}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Query-swift.struct\/init(rating:)"},"kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"code":"Query","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/query-swift.struct\/init(rating:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"init","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO5InputV5QueryV6ratingAISiSg_tcfc","roleHeading":"Initializer","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Rating","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO6Ratinga","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"title":"init(rating:)"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease":{"kind":"symbol","navigatorTitle":[{"text":"PostChangeRatingOfRelease","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostChangeRatingOfRelease","kind":"identifier"}],"abstract":[{"text":"Update a rating for a specified release instance in a specified collection folder of a user.","type":"text"}],"title":"Operations.PostChangeRatingOfRelease","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Query-swift.struct/init(rating:)":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/query-swift.struct\/init(rating:)","kind":"symbol","title":"init(rating:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Query"},{"type":"text","text":"."}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"Rating","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO6Ratinga"},{"text":"?)","kind":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Query-swift.struct\/init(rating:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input":{"title":"Operations.PostChangeRatingOfRelease.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Rating":{"title":"Components.Parameters.Rating","navigatorTitle":[{"text":"Rating","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Rating","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Rating","kind":"identifier"}],"abstract":[{"text":"A number for a rating of a release.","type":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/rating","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Query-swift.struct":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/query-swift.struct","kind":"symbol","title":"Operations.PostChangeRatingOfRelease.Input.Query","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Query"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Query-swift.struct","navigatorTitle":[{"text":"Query","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"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":{"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/Components/Parameters":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Parameters","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/parameters"},{"type":"text","text":" section of the OpenAPI document."}],"title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"}}}