rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/authmiddleware/init(method:transport:).json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

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

1 line
6.4 KiB
JSON
Raw Blame History

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