javier
b14a9fa816
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>
43 lines
782 B
Markdown
43 lines
782 B
Markdown
# ``DiscogsService``
|
|
|
|
A Swift client library for the Discogs API, built on top of Swift OpenAPI.
|
|
|
|
## Overview
|
|
|
|
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
|
|
|
|
### Clients
|
|
|
|
- ``Client``
|
|
|
|
### Servers
|
|
|
|
- ``LiveService``
|
|
|
|
### Authentication
|
|
|
|
- ``AuthMiddleware``
|
|
- ``AuthMethod``
|
|
- ``AuthTransport``
|
|
|
|
### User Agent
|
|
|
|
- ``UserAgentMiddleware``
|
|
- ``Product``
|
|
|
|
### Types
|
|
|
|
- ``Components``
|
|
- ``Operations``
|
|
- ``Servers``
|
|
|
|
### Errors
|
|
|
|
- ``InputValidationError``
|
|
|
|
### Protocols
|
|
|
|
- ``APIProtocol``
|