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