javier
bfc9e67d38
This PR contains the work done to implement the `AuthMiddleware` middleware, to authenticate the requests sent to the backend service, based on [their specifications](https://www.discogs.com/developers/#page:authentication). In addition, some documentation has been added/updated and some boilerplate source code has been removed from the project. Reviewed-on: #3 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
34 lines
1.5 KiB
Swift
34 lines
1.5 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the DiscogsService open source project
|
|
//
|
|
// Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of DiscogsService project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
/// A representation of the available transport options to send credentials in authenticated requests.
|
|
public enum AuthTransport: Sendable {
|
|
/// Authentication credential are sent in a request as an `Authentication` header.
|
|
///
|
|
/// This means that the header will be added to any existing header in a request, like this:
|
|
/// ```bash
|
|
/// curl "https://api.discogs.com/database/search?q=Slayer" -H "Authorization: Discogs key=foo123, secret=bar456"
|
|
/// curl "https://api.discogs.com/database/search?q=Slayer" -H "Authorization: Discogs token=abcxyz123456"
|
|
/// ```
|
|
case onHeader
|
|
/// Authentication credential are sent in a request as parameters in the query string.
|
|
///
|
|
/// This means that the parameters will be injected into the query in a request, like this:
|
|
/// ```bash
|
|
/// curl "https://api.discogs.com/database/search?q=Slayer&key=foo123&secret=bar456"
|
|
/// curl "https://api.discogs.com/database/search?q=Slayer&token=abcxyz123456"
|
|
/// ```
|
|
case onQuery
|
|
}
|