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

{"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"method","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","preciseIdentifier":"s:14DiscogsService10AuthMethodO","text":"AuthMethod","kind":"typeIdentifier"},{"text":" = .none, ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport","preciseIdentifier":"s:14DiscogsService13AuthTransportO","text":"AuthTransport","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"method","content":[{"inlineContent":[{"text":"A representation of an authentication method to use to authenticate requests.","type":"text"}],"type":"paragraph"}]},{"name":"transport","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A representation of a transport option to send credentials in requests."}]}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"content":[{"inlineContent":[{"text":"An error of type ","type":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError","type":"reference","isActive":true},{"text":" in case an input failed any validation.","type":"text"}],"type":"paragraph"}],"name":"Throws","type":"aside","style":"note"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/authmiddleware\/init(method:transport:)"]}],"metadata":{"symbolKind":"init","role":"symbol","title":"init(method:transport:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService14AuthMiddlewareV6method9transportAcA0C6MethodO_AA0C9TransportOtKcfc","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"method"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10AuthMethodO","kind":"typeIdentifier","text":"AuthMethod"},{"kind":"text","text":", "},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService13AuthTransportO","kind":"typeIdentifier","text":"AuthTransport"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware\/init(method:transport:)"},"abstract":[{"text":"Initializes this middleware.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/AuthTransport":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport","abstract":[{"type":"text","text":"A representation of the available transport options to send credentials in authenticated requests."}],"type":"topic","title":"AuthTransport","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthTransport","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/authtransport","navigatorTitle":[{"text":"AuthTransport","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/InputValidationError":{"abstract":[{"type":"text","text":"A representation of all the possible validation errors that could be thrown while validating an input."}],"url":"\/documentation\/discogsservice\/inputvalidationerror","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"InputValidationError"}],"navigatorTitle":[{"kind":"identifier","text":"InputValidationError"}],"role":"symbol","title":"InputValidationError","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/AuthMiddleware":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","abstract":[{"type":"text","text":"A middleware that attaches any defined authentication credentials into the requests to the service."}],"type":"topic","title":"AuthMiddleware","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/authmiddleware","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}]},"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/AuthMethod":{"abstract":[{"text":"A representation of the available authentication methods at the Discogs service.","type":"text"}],"url":"\/documentation\/discogsservice\/authmethod","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthMethod"}],"navigatorTitle":[{"text":"AuthMethod","kind":"identifier"}],"role":"symbol","title":"AuthMethod","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/AuthMiddleware/init(method:transport:)":{"title":"init(method:transport:)","type":"topic","url":"\/documentation\/discogsservice\/authmiddleware\/init(method:transport:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"method","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10AuthMethodO","text":"AuthMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService13AuthTransportO","text":"AuthTransport","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware\/init(method:transport:)","kind":"symbol","abstract":[{"type":"text","text":"Initializes this middleware."}],"role":"symbol"}}}