rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/client/init(serverurl:configuration:transport:middlewares:).json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 15:20:20 +00:00

1 line
7.1 KiB
JSON
Raw Blame History

{"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"serverURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"configuration"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Configuration","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"ClientTransport","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"middlewares"},{"kind":"text","text":": [any "},{"kind":"typeIdentifier","text":"ClientMiddleware","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP"},{"kind":"text","text":"] = [])"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The server URL that the client connects to. Any server"},{"type":"text","text":" "},{"type":"text","text":"URLs defined in the OpenAPI document are available as static methods"},{"type":"text","text":" "},{"type":"text","text":"on the "},{"type":"reference","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","isActive":true},{"type":"text","text":" type."}],"type":"paragraph"}],"name":"serverURL"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A set of configuration values for the client."}]}],"name":"configuration"},{"name":"transport","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A transport that performs HTTP operations."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"A list of middlewares to call before the transport."}],"type":"paragraph"}],"name":"middlewares"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/init(serverURL:configuration:transport:middlewares:)"},"kind":"symbol","abstract":[{"type":"text","text":"Creates a new client."}],"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"serverURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"configuration"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Configuration","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"ClientTransport","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"middlewares"},{"kind":"text","text":": [any "},{"kind":"typeIdentifier","text":"ClientMiddleware","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP"},{"kind":"text","text":"])"}],"title":"init(serverURL:configuration:transport:middlewares:)","role":"symbol","externalID":"s:14DiscogsService6ClientV9serverURL13configuration9transport11middlewaresAC10Foundation0E0V_14OpenAPIRuntime13ConfigurationVAK0C9Transport_pSayAK0C10Middleware_pGtcfc","roleHeading":"Initializer","modules":[{"name":"DiscogsService"}],"symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/init(serverurl:configuration:transport:middlewares:)"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Client"}],"navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","url":"\/documentation\/discogsservice\/client","abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"text":", ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"text":". Your application can also manage ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"text":" and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Wantlists"}]},{"text":", create ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"text":" listings, and more.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"},"doc://DiscogsService/documentation/DiscogsService/Client/init(serverURL:configuration:transport:middlewares:)":{"type":"topic","title":"init(serverURL:configuration:transport:middlewares:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/init(serverURL:configuration:transport:middlewares:)","abstract":[{"type":"text","text":"Creates a new client."}],"kind":"symbol","url":"\/documentation\/discogsservice\/client\/init(serverurl:configuration:transport:middlewares:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"serverURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"configuration"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Configuration","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"ClientTransport","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"middlewares"},{"kind":"text","text":": [any "},{"kind":"typeIdentifier","text":"ClientMiddleware","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP"},{"kind":"text","text":"])"}]},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Servers":{"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"title":"Servers","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"}}}
View Git Blame Copy Permalink