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

{"sections":[],"abstract":[{"type":"text","text":"Creates a new "},{"code":"Ok","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","text":"PostUserProfile","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct\/Body-swift.enum","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Received HTTP response headers","type":"text"}]}],"name":"headers"},{"content":[{"inlineContent":[{"type":"text","text":"Received HTTP response body"}],"type":"paragraph"}],"name":"body"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct\/init(headers:body:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"roleHeading":"Initializer","modules":[{"name":"DiscogsService"}],"symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","text":"PostUserProfile"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV7HeadersV","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","text":"PostUserProfile"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV","text":"Ok"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV4BodyO","text":"Body"},{"kind":"text","text":")"}],"externalID":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc","role":"symbol","title":"init(headers:body:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postuserprofile\/output\/ok-swift.struct\/init(headers:body:)"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Output/Ok-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct","title":"Operations.PostUserProfile.Output.Ok","type":"topic","url":"\/documentation\/discogsservice\/operations\/postuserprofile\/output\/ok-swift.struct","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Output"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.PostUserProfile.Output","url":"\/documentation\/discogsservice\/operations\/postuserprofile\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Output/Ok-swift.struct/Body-swift.enum":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/postuserprofile\/output\/ok-swift.struct\/body-swift.enum","kind":"symbol","title":"Operations.PostUserProfile.Output.Ok.Body","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct\/Body-swift.enum","navigatorTitle":[{"kind":"identifier","text":"Body"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Output/Ok-swift.struct/init(headers:body:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"title":"init(headers:body:)","url":"\/documentation\/discogsservice\/operations\/postuserprofile\/output\/ok-swift.struct\/init(headers:body:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct\/init(headers:body:)","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/Operations/PostUserProfile":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PostUserProfile"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","type":"topic","role":"symbol","title":"Operations.PostUserProfile","abstract":[{"text":"Update information about a user.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PostUserProfile"}],"url":"\/documentation\/discogsservice\/operations\/postuserprofile"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Output/Ok-swift.struct/Headers-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output\/Ok-swift.struct\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"abstract":[],"title":"Operations.PostUserProfile.Output.Ok.Headers","type":"topic","url":"\/documentation\/discogsservice\/operations\/postuserprofile\/output\/ok-swift.struct\/headers-swift.struct"},"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"}}}