Files

1 line
12 KiB
JSON
Raw Permalink Normal View History

2026-03-24 01:54:43 +00:00
{"sections":[],"abstract":[{"text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI.","type":"text"}],"kind":"symbol","primaryContentSections":[{"kind":"content","content":[{"level":2,"text":"Overview","anchor":"Overview","type":"heading"},{"inlineContent":[{"text":"This library provides a type-safe client for interacting with the ","type":"text"},{"isActive":true,"identifier":"https:\/\/www.discogs.com\/developers","type":"reference"},{"text":", 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.","type":"text"}],"type":"paragraph"},{"level":2,"text":"Installation","anchor":"Installation","type":"heading"},{"inlineContent":[{"type":"text","text":"To use this library, then add it as a dependency in the "},{"type":"codeVoice","code":"Package.swift"},{"type":"text","text":" file of your project:"}],"type":"paragraph"},{"syntax":"swift","code":[" let package = Package("," \/\/ name, platforms, products, etc."," dependencies: ["," .package(url: \"https:\/\/github.com\/rock-n-code\/discogs-service\", from: \"0.6.1\"),"," \/\/ other dependencies"," ],"," targets: ["," .target("," name: \"SomeTarget\","," dependencies: ["," .product(name: \"DiscogsService\", package: \"discogs-service\"),"," ]"," )"," \/\/ other targets"," ]"," )"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"It is also possible to use this library with your app in Xcode, then add it as a dependency in your Xcode project."}],"type":"paragraph"},{"style":"important","name":"Important","content":[{"inlineContent":[{"type":"text","text":"Swift 5.10 or higher is required in order to compile this library."}],"type":"paragraph"}],"type":"aside"}]}],"hierarchy":{"paths":[[]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"roleHeading":"Framework","externalID":"DiscogsService","title":"DiscogsService","modules":[{"name":"DiscogsService"}],"symbolKind":"module","role":"collection"},"topicSections":[{"title":"Clients","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"],"anchor":"Clients"},{"title":"Servers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/LiveService"],"anchor":"Servers"},{"title":"Authentication","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport"],"anchor":"Authentication"},{"title":"User Agent","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product"],"anchor":"User-Agent"},{"title":"Types","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"],"anchor":"Types"},{"title":"Errors","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError"],"anchor":"Errors"},{"title":"Protocols","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"],"anchor":"Protocols"}],"variants":[{"paths":["\/documentation\/discogsservice"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"sy