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.9 KiB
JSON

{"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/14OpenAPIRuntime16ClientMiddlewareP","doc:\/\/DiscogsService\/s8CopyableP","doc:\/\/DiscogsService\/s9EscapableP","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"sections":[],"abstract":[{"type":"text","text":"A middleware that attaches any defined authentication credentials into the requests to the service."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthMiddleware"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"overview","type":"heading","text":"Overview","level":2},{"inlineContent":[{"text":"Please refer to the ","type":"text"},{"identifier":"https:\/\/www.discogs.com\/developers#page:authentication","type":"reference","isActive":true},{"text":" for further information.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"modules":[{"name":"DiscogsService"}],"roleHeading":"Structure","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}],"navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"role":"symbol","externalID":"s:14DiscogsService14AuthMiddlewareV","title":"AuthMiddleware"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware\/init(method:transport:)"],"generated":true,"anchor":"Initializers"},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware\/ClientMiddleware-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"variants":[{"paths":["\/documentation\/discogsservice\/authmiddleware"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"title":"Authentication","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport"],"generated":true,"anchor":"Authentication"}],"references":{"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."}]},"https://www.discogs.com/developers#page:authentication":{"identifier":"https:\/\/www.discogs.com\/developers#page:authentication","titleInlineContent":[{"type":"text","text":"Discogs documentation"}],"type":"link","url":"https:\/\/www.discogs.com\/developers#page:authentication","title":"Discogs documentation"},"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":{"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/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"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"},"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/s8CopyableP":{"identifier":"doc:\/\/DiscogsService\/s8CopyableP","type":"unresolvable","title":"Swift.Copyable"},"doc://DiscogsService/documentation/DiscogsService/AuthMiddleware/ClientMiddleware-Implementations":{"title":"ClientMiddleware Implementations","type":"topic","url":"\/documentation\/discogsservice\/authmiddleware\/clientmiddleware-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware\/ClientMiddleware-Implementations","kind":"article","abstract":[],"role":"collectionGroup"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/14OpenAPIRuntime16ClientMiddlewareP":{"identifier":"doc:\/\/DiscogsService\/14OpenAPIRuntime16ClientMiddlewareP","type":"unresolvable","title":"OpenAPIRuntime.ClientMiddleware"},"doc://DiscogsService/s9EscapableP":{"identifier":"doc:\/\/DiscogsService\/s9EscapableP","title":"Swift.Escapable","type":"unresolvable"}}}