Documentation improvements (#16)

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:
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
@@ -1,10 +1,10 @@
# ``DiscogsService``
<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@-->
A Swift client library for the Discogs API, built on top of Swift OpenAPI.
## Overview
<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
This library provides a type-safe client for interacting with the [Discogs API](https://www.discogs.com/developers), including endpoints for the database, user identity, user collections, wantlists, lists, and the marketplace. It supports multiple authentication methods and transports credentials via headers or query parameters.
## Topics