javier
428eedd89d
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>
69 lines
2.1 KiB
Swift
69 lines
2.1 KiB
Swift
// swift-tools-version: 5.10
|
|
|
|
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the DiscogsService open source project
|
|
//
|
|
// Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of DiscogsService project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
import PackageDescription
|
|
|
|
let package = Package(
|
|
name: DiscogsService.package,
|
|
platforms: [
|
|
.iOS(.v13),
|
|
.macOS(.v10_15),
|
|
.tvOS(.v13),
|
|
.visionOS(.v1),
|
|
.watchOS(.v6)
|
|
],
|
|
products: [
|
|
.library(
|
|
name: DiscogsService.package,
|
|
targets: [DiscogsService.target]
|
|
),
|
|
],
|
|
dependencies: [
|
|
.package(url: "https://github.com/apple/swift-openapi-generator.git", from: "1.3.0"),
|
|
.package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.5.0"),
|
|
.package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.2"),
|
|
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0")
|
|
],
|
|
targets: [
|
|
.target(
|
|
name: DiscogsService.target,
|
|
dependencies: [
|
|
.product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
|
|
.product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession")
|
|
],
|
|
path: "Sources/\(DiscogsService.target)",
|
|
plugins: [
|
|
.plugin(name: "OpenAPIGenerator", package: "swift-openapi-generator")
|
|
]
|
|
),
|
|
.testTarget(
|
|
name: DiscogsService.test,
|
|
dependencies: [
|
|
.byName(name: DiscogsService.target)
|
|
],
|
|
path: "Tests/\(DiscogsService.target)"
|
|
),
|
|
]
|
|
)
|
|
|
|
// MARK: - Constants
|
|
|
|
enum DiscogsService {
|
|
static let package = "discogs-service"
|
|
static let target = "DiscogsService"
|
|
static let test = "\(DiscogsService.target)Tests"
|
|
}
|