Files
discogs-service/docs/data/documentation/discogsservice/client/init(serverurl:configuration:transport:middlewares:).json
T
javier 428eedd89d Implemented the Services and Database GET endpoints (#2)
This PR contains the work done to include the define the information sections of the `OpenAPI` specification document and all the `GET` endpoints of the _Service_ and _Database_ categories.

The following endpoints have been defined in the document, and also tested manually with `Swift`:
* GET `/`
* GET `/artists/{artist_id}`
* GET `/artists/{artist_id}/releases`
* GET `/labels/{label_id}`
* GET `/labels/{label_id}/releases`
* GET `/masters/{master_id}`
* GET `/masters/{master_id}/versions`
* GET `/releases/{release_id}`
* GET `/releases/{release_id}/rating`
* GET `/releases/{release_id}/rating/{username}`
* GET `/releases/{release_id}/stats`
* GET `/database/search`

In addition, a first version of the _Github Pages_ documentation has been generated from the `DocC` documentation catalog, and the generated Swift code from the `openapi.yaml` file.

Reviewed-on: #2
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-09 23:51:39 +00:00

1 line
7.1 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"serverURL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"configuration","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Configuration","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"middlewares","kind":"externalParam"},{"text":": [any ","kind":"text"},{"text":"ClientMiddleware","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP","kind":"typeIdentifier"},{"text":"] = [])","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","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","isActive":true,"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},{"type":"text","text":" type."}]}],"name":"serverURL"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A set of configuration values for the client."}]}],"name":"configuration"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A transport that performs HTTP operations."}]}],"name":"transport"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A list of middlewares to call before the transport."}]}],"name":"middlewares"}],"kind":"parameters"}],"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/init(serverURL:configuration:transport:middlewares:)"},"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"serverURL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"configuration","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Configuration","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"middlewares","kind":"externalParam"},{"text":": [any ","kind":"text"},{"text":"ClientMiddleware","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP","kind":"typeIdentifier"},{"text":"])","kind":"text"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","symbolKind":"init","externalID":"s:14DiscogsService6ClientV9serverURL13configuration9transport11middlewaresAC10Foundation0E0V_14OpenAPIRuntime13ConfigurationVAK0C9Transport_pSayAK0C10Middleware_pGtcfc","roleHeading":"Initializer","title":"init(serverURL:configuration:transport:middlewares:)"},"abstract":[{"type":"text","text":"Creates a new client."}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/init(serverurl:configuration:transport:middlewares:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Client":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"title":"Client","role":"symbol","abstract":[{"type":"text","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":"emphasis","inlineContent":[{"text":"Artists","type":"text"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"text":"Releases","type":"text"}]},{"type":"text","text":", and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"type":"text","text":". Your application can also manage "},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"text":", create ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"text":" listings, and more.","type":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/client"},"doc://DiscogsService/documentation/DiscogsService/Servers":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"title":"Servers","role":"symbol","abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"kind":"symbol","url":"\/documentation\/discogsservice\/servers"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Client/init(serverURL:configuration:transport:middlewares:)":{"title":"init(serverURL:configuration:transport:middlewares:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/init(serverURL:configuration:transport:middlewares:)","type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"serverURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":", "},{"kind":"externalParam","text":"configuration"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV","text":"Configuration"},{"text":", ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"text":", ","kind":"text"},{"text":"middlewares","kind":"externalParam"},{"text":": [any ","kind":"text"},{"preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP","text":"ClientMiddleware","kind":"typeIdentifier"},{"text":"])","kind":"text"}],"kind":"symbol","abstract":[{"type":"text","text":"Creates a new client."}],"role":"symbol","url":"\/documentation\/discogsservice\/client\/init(serverurl:configuration:transport:middlewares:)"}}}