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
16 KiB
JSON

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Username","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"folderId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"FolderId","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8FolderIda","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FolderId","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"releaseId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"ReleaseId","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"instanceId","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InstanceId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO10InstanceIda","text":"InstanceId"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"A username of a user.","type":"text"}],"type":"paragraph"}],"name":"username"},{"content":[{"inlineContent":[{"text":"An identifier of a collection folder.","type":"text"}],"type":"paragraph"}],"name":"folderId"},{"content":[{"inlineContent":[{"type":"text","text":"An identifier of a release."}],"type":"paragraph"}],"name":"releaseId"},{"content":[{"type":"paragraph","inlineContent":[{"text":"An identifier of a release instance.","type":"text"}]}],"name":"instanceId"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"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\/Path-swift.struct"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/init(username:folderid:releaseid:instanceid:)"]}],"metadata":{"symbolKind":"init","role":"symbol","title":"init(username:folderId:releaseId:instanceId:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO5InputV4PathV8username8folderId07releaseM008instanceM0AISS_S3itcfc","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"username","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":"Username","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea"},{"text":", ","kind":"text"},{"text":"folderId","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":"FolderId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8FolderIda"},{"text":", ","kind":"text"},{"text":"releaseId","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":"ReleaseId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda"},{"text":", ","kind":"text"},{"text":"instanceId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO10InstanceIda","text":"InstanceId","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/init(username:folderId:releaseId:instanceId:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Path"},{"type":"text","text":"."}],"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/Components/Parameters/Username":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username","title":"Components.Parameters.Username","type":"topic","url":"\/documentation\/discogsservice\/components\/parameters\/username","abstract":[{"text":"A username of a user.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Username"}],"navigatorTitle":[{"kind":"identifier","text":"Username"}]},"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/InstanceId":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/instanceid","kind":"symbol","title":"Components.Parameters.InstanceId","abstract":[{"text":"An identifier of a release instance.","type":"text"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"InstanceId"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InstanceId","navigatorTitle":[{"kind":"identifier","text":"InstanceId"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/FolderId":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"FolderId"}],"kind":"symbol","role":"symbol","title":"Components.Parameters.FolderId","url":"\/documentation\/discogsservice\/components\/parameters\/folderid","abstract":[{"type":"text","text":"An identifier of a collection folder."}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"FolderId"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/FolderId"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct":{"title":"Operations.PostChangeRatingOfRelease.Input.Path","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"navigatorTitle":[{"text":"Path","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct","kind":"symbol","abstract":[],"role":"symbol"},"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/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct/init(username:folderId:releaseId:instanceId:)":{"kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Username","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea"},{"kind":"text","text":", "},{"kind":"externalParam","text":"folderId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"FolderId","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8FolderIda"},{"kind":"text","text":", "},{"kind":"externalParam","text":"releaseId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"ReleaseId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda"},{"text":", ","kind":"text"},{"text":"instanceId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO10InstanceIda","text":"InstanceId"},{"text":")","kind":"text"}],"title":"init(username:folderId:releaseId:instanceId:)","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/init(username:folderid:releaseid:instanceid:)","type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Path"},{"type":"text","text":"."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/init(username:folderId:releaseId:instanceId:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ReleaseId":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId","title":"Components.Parameters.ReleaseId","type":"topic","url":"\/documentation\/discogsservice\/components\/parameters\/releaseid","abstract":[{"type":"text","text":"An identifier of a release."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"ReleaseId","kind":"identifier"}],"navigatorTitle":[{"text":"ReleaseId","kind":"identifier"}]},"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"},"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/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"}}}