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

{"metadata":{"externalID":"s:14DiscogsService10OperationsO15GetCustomFieldsO5InputV4PathV8usernameSSvp","symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"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:14DiscogsService10ComponentsO10ParametersO8Usernamea","text":"Username","kind":"typeIdentifier"}],"modules":[{"name":"DiscogsService"}],"roleHeading":"Instance Property","title":"username"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"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"}]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/users\/{username}\/collection\/fields\/GET\/path\/username"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark","style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Input\/Path-swift.struct"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcustomfields\/input\/path-swift.struct\/username"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Input\/Path-swift.struct\/username"},"abstract":[{"type":"text","text":"A username of a user."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCustomFields/Input":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Input","title":"Operations.GetCustomFields.Input","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcustomfields\/input","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCustomFields/Input/Path-swift.struct":{"title":"Operations.GetCustomFields.Input.Path","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcustomfields\/input\/path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Input\/Path-swift.struct","kind":"symbol","abstract":[],"role":"symbol"},"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/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/Operations/GetCustomFields/Input/Path-swift.struct/username":{"url":"\/documentation\/discogsservice\/operations\/getcustomfields\/input\/path-swift.struct\/username","abstract":[{"type":"text","text":"A username of a user."}],"title":"username","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Username","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Input\/Path-swift.struct\/username","role":"symbol"},"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/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/GetCustomFields":{"navigatorTitle":[{"text":"GetCustomFields","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCustomFields","kind":"identifier"}],"title":"Operations.GetCustomFields","url":"\/documentation\/discogsservice\/operations\/getcustomfields","type":"topic","abstract":[{"text":"Get a list of custom fields defined by a user.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields","role":"symbol"}}}