rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity

Improved the source code documentation of the source code in the package.

Browse Source
This commit is contained in:
Javier Cicchelli
2026-03-24 01:26:27 +01:00
parent 25b62a4f67
commit a559ae0163
14 changed files with 50 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/DiscogsService/Public/Enumerations/AuthTransport.swift
+5 -2
View File
@@ -13,8 +13,11 @@
// ===----------------------------------------------------------------------===
/// A representation of the available transport options to send credentials in authenticated requests.
///
/// This enumeration is used in conjunction with ``AuthMiddleware`` to determine how authentication credentials
/// are attached to outgoing requests.
public enum AuthTransport: CaseIterable, Sendable {
/// Authentication credential are sent in a request as an `Authentication` header.
/// Authentication credentials are sent in a request as an `Authorization` header.
///
/// This means that the header will be added to any existing header in a request, like this:
/// ```bash
@@ -22,7 +25,7 @@ public enum AuthTransport: CaseIterable, Sendable {
/// 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.
/// Authentication credentials 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