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

Documentation improvements (#16)

Browse Source 
This PR contains the work done to improve the documentation efforts in the package, aiming at improving the documentation of the source code as well as the OpenAPI specification document. In addition, a breaking bug has been fixed.

Reviewed-on: #16
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #16.
This commit is contained in:
Javier Cicchelli
2026-03-24 01:22:53 +00:00
committed by Javier Cicchelli
parent a0672cc4af
commit b14a9fa816
35 changed files with 196 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/DiscogsService/Public/Enumerations/AuthMethod.swift
+1 -1
View File
@@ -2,7 +2,7 @@
//
// This source file is part of the DiscogsService open source project
//
// Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors
// Copyright (c) 2026 Röck+Cöde VoF. and the DiscogsService project authors
// Licensed under Apache license v2.0
//
// See LICENSE for license information
Sources/DiscogsService/Public/Enumerations/AuthTransport.swift
+6 -3
View File
@@ -2,7 +2,7 @@
//
// This source file is part of the DiscogsService open source project
//
// Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors
// Copyright (c) 2026 Röck+Cöde VoF. and the DiscogsService project authors
// Licensed under Apache license v2.0
//
// See LICENSE for license information
@@ -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