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
12 KiB
JSON
1 line
12 KiB
JSON
{"sections":[],"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Headers"},{"text":".","type":"text"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"userAgent","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":"UserAgent","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9UserAgenta","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/UserAgent","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"accept","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"AcceptHeaderContentType","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV"},{"text":"<","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetRequestToken","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken","preciseIdentifier":"s:14DiscogsService10OperationsO15GetRequestTokenO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/AcceptableContentType","preciseIdentifier":"s:14DiscogsService10OperationsO15GetRequestTokenO21AcceptableContentTypeO","text":"AcceptableContentType"},{"kind":"text","text":">] = .defaultValues())"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"userAgent","content":[{"inlineContent":[{"type":"text","text":"A name of a software agent responsible for interacting with the service."}],"type":"paragraph"}]},{"name":"accept","content":[{"inlineContent":[{"type":"text","text":""}],"type":"paragraph"}]}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/Input\/Headers-swift.struct"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/Input\/Headers-swift.struct\/init(userAgent:accept:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"modules":[{"name":"DiscogsService"}],"roleHeading":"Initializer","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userAgent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier","text":"Parameters"},{"kind":"text","text":"."},{"text":"UserAgent","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9UserAgenta"},{"text":", ","kind":"text"},{"text":"accept","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"AcceptHeaderContentType","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV"},{"text":"<","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetRequestToken","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetRequestTokenO"},{"text":".","kind":"text"},{"text":"AcceptableContentType","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetRequestTokenO21AcceptableContentTypeO"},{"text":">])","kind":"text"}],"externalID":"s:14DiscogsService10OperationsO15GetRequestTokenO5InputV7HeadersV9userAgent6acceptAISS_Say14OpenAPIRuntime23AcceptHeaderContentTypeVyAE010AcceptablepQ0OGGtcfc","role":"symbol","title":"init(userAgent:accept:)"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getrequesttoken\/input\/headers-swift.struct\/init(useragent:accept:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetRequestToken":{"navigatorTitle":[{"kind":"identifier","text":"GetRequestToken"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetRequestToken"}],"title":"Operations.GetRequestToken","url":"\/documentation\/discogsservice\/operations\/getrequesttoken","type":"topic","abstract":[{"text":"Get details about an OAuth request token.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken","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/GetRequestToken/Input/Headers-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"title":"Operations.GetRequestToken.Input.Headers","url":"\/documentation\/discogsservice\/operations\/getrequesttoken\/input\/headers-swift.struct","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/Input\/Headers-swift.struct","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/Operations/GetRequestToken/Input":{"kind":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"abstract":[],"title":"Operations.GetRequestToken.Input","url":"\/documentation\/discogsservice\/operations\/getrequesttoken\/input","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRequestToken/Input/Headers-swift.struct/init(userAgent:accept:)":{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Headers"},{"type":"text","text":"."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/Input\/Headers-swift.struct\/init(userAgent:accept:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9UserAgenta","text":"UserAgent"},{"kind":"text","text":", "},{"kind":"externalParam","text":"accept"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","text":"AcceptHeaderContentType"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetRequestTokenO","text":"GetRequestToken"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetRequestTokenO21AcceptableContentTypeO","text":"AcceptableContentType"},{"kind":"text","text":">])"}],"title":"init(userAgent:accept:)","kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getrequesttoken\/input\/headers-swift.struct\/init(useragent:accept:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRequestToken/AcceptableContentType":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/getrequesttoken\/acceptablecontenttype","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRequestToken\/AcceptableContentType","role":"symbol","kind":"symbol","title":"Operations.GetRequestToken.AcceptableContentType","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}]},"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/UserAgent":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/UserAgent","title":"Components.Parameters.UserAgent","url":"\/documentation\/discogsservice\/components\/parameters\/useragent","type":"topic","abstract":[{"type":"text","text":"A name of a software agent responsible for interacting with the service."}],"kind":"symbol","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"UserAgent","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"}}} |