Files
discogs-service/docs/data/documentation/discogsservice/authmiddleware/init(method:transport:).json
T
javier 39e9dc5d53 Fox to Authentication endpoints (#10)
This PR contains the rock done to securize the /GET `/oauth/identity` endpoints on the OpenAPI specification document, plus it also improves the endpoints ordering in the *Database* section.

Reviewed-on: #10
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 18:41:24 +00:00

1 line
6.4 KiB
JSON

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