From ea6138bf854a591e29061512de48bd81fc6fea0b Mon Sep 17 00:00:00 2001 From: GErP83 Date: Wed, 4 Feb 2026 12:35:13 +0100 Subject: [PATCH 1/4] text formating, change workflows --- .github/workflows/deployment.yml | 1 + .github/workflows/testing.yml | 4 +- Makefile | 5 ++- README.md | 70 +++++++++----------------------- 4 files changed, 27 insertions(+), 53 deletions(-) diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 680623b..672e272 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -5,6 +5,7 @@ on: tags: - 'v*' - '[0-9]*' + workflow_dispatch: jobs: diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index ebfae0b..68dadfa 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -15,7 +15,7 @@ jobs: format_check_enabled : true broken_symlink_check_enabled : true unacceptable_language_check_enabled : true - shell_check_enabled : true + shell_check_enabled : false docs_check_enabled : false api_breakage_check_enabled : false license_header_check_enabled : false @@ -27,7 +27,7 @@ jobs: uses: BinaryBirds/github-workflows/.github/workflows/extra_soundness.yml@main with: local_swift_dependencies_check_enabled : true - headers_check_enabled : true + headers_check_enabled : false docc_warnings_check_enabled : true swiftlang_tests: diff --git a/Makefile b/Makefile index 8c5a82c..072a467 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,10 @@ SHELL=/bin/bash baseUrl = https://raw.githubusercontent.com/BinaryBirds/github-workflows/refs/heads/main/scripts -check: symlinks language deps lint headers +check: symlinks language deps lint headers package docc-warnings + +package: + curl -s $(baseUrl)/check-swift-package.sh | bash symlinks: curl -s $(baseUrl)/check-broken-symlinks.sh | bash diff --git a/README.md b/README.md index f8c2340..c9bef3f 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,28 @@ The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Swift in a type-safe way. -[ - ![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138) -]( - https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.1 -) +[![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138)](https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.1) ## Features -- 🤝 Type-safe interface for building OpenAPI documents -- 🔀 Automatic identifier generation and resolution -- 📚 DocC-based API Documentation -- ✅ Unit tests and code coverage +- Type-safe interface for building OpenAPI documents +- Automatic identifier generation and resolution +- DocC-based API Documentation +- Unit tests and code coverage ## Requirements ![Swift 6.1+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138) ![Platforms: Linux, macOS, iOS, tvOS, watchOS, visionOS](https://img.shields.io/badge/Platforms-Linux_%7C_macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS-F05138) - -- Swift 6.1+ -- Platforms: - - Linux - - macOS 15+ - - iOS 18+ - - tvOS 18+ - - watchOS 11+ - - visionOS 2+ +- Swift 6.1+ +- Platforms: + - Linux + - macOS 15+ + - iOS 18+ + - tvOS 18+ + - watchOS 11+ + - visionOS 2+ ## Installation @@ -45,48 +40,23 @@ Then add `FeatherOpenAPI` to your target dependencies: ``` ## Usage - -[ - ![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138) -] ( - https://feather-framework.github.io/feather-openapi/documentation/featheropenapi/ -) -API documentation is available at the following link. +[![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)] (https://feather-framework.github.io/feather-openapi/) + +API documentation is available at the following link. > [!WARNING] > This repository is a work in progress, things can break until it reaches v1.0.0. - ## Development - Build: `swift build` -- Test: - - local: `swift test` - - using Docker: `make docker-test` +- Test: + - local: `swift test` + - using Docker: `make docker-test` - Format: `make format` - Check: `make check` ## Contributing -[Pull requests](https://github.com/feather-framework/feather-openapi/pulls) are welcome. Please keep changes focused and include tests for new logic. 🙏 - - - - - - - - - - - - - - - - - - - - +[Pull requests](https://github.com/feather-framework/feather-openapi/pulls) are welcome. Please keep changes focused and include tests for new logic. From ade4b0a5e2fcb0393f64c68cd625394bd406bf8d Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Thu, 5 Feb 2026 12:00:01 +0100 Subject: [PATCH 2/4] bump dep --- Package.resolved | 6 +++--- Package.swift | 2 +- README.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Package.resolved b/Package.resolved index b04da86..2eae2d9 100644 --- a/Package.resolved +++ b/Package.resolved @@ -1,13 +1,13 @@ { - "originHash" : "df64111ed452c60afbaa75cf2d9c28bb55f995528b996f33f93d70fa99af4850", + "originHash" : "72f8ba09f8e688d42521f46e515d551133ce026caec7c1aab7162e00039ee29c", "pins" : [ { "identity" : "openapikit", "kind" : "remoteSourceControl", "location" : "https://github.com/mattpolzin/OpenAPIKit", "state" : { - "revision" : "d267e29373b3d2ff395d3b46d8bf2085a9263f67", - "version" : "5.0.0-rc.2" + "revision" : "f23fdf4223fcd780588e19c7ad823749c08bd2bf", + "version" : "5.0.0" } }, { diff --git a/Package.swift b/Package.swift index 445a366..31be3d7 100644 --- a/Package.swift +++ b/Package.swift @@ -34,7 +34,7 @@ let package = Package( .library(name: "FeatherOpenAPI", targets: ["FeatherOpenAPI"]), ], dependencies: [ - .package(url: "https://github.com/mattpolzin/OpenAPIKit", exact: "5.0.0-rc.2"), + .package(url: "https://github.com/mattpolzin/OpenAPIKit", from: "5.0.0"), .package(url: "https://github.com/jpsim/Yams", from: "6.2.0"), // [docc-plugin-placeholder] ], diff --git a/README.md b/README.md index c9bef3f..cf4abd5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Swift in a type-safe way. -[![Release: 1.0.0-beta.1](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E1-F05138)](https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.1) +[![Release: 1.0.0-beta.2](https://img.shields.io/badge/Release-1.0.0-beta.2-F05138)](https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.2) ## Features @@ -30,7 +30,7 @@ The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Use Swift Package Manager; add the dependency to your `Package.swift` file: ```swift -.package(url: "https://github.com/feather-framework/feather-openapi", exact: "1.0.0-beta.1"), +.package(url: "https://github.com/feather-framework/feather-openapi", exact: "1.0.0-beta.2"), ``` Then add `FeatherOpenAPI` to your target dependencies: From 30c01f6cb87dc2ec137254ae76c4b38e2e554be6 Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Thu, 5 Feb 2026 12:04:05 +0100 Subject: [PATCH 3/4] fix readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cf4abd5..12a3e45 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Swift in a type-safe way. -[![Release: 1.0.0-beta.2](https://img.shields.io/badge/Release-1.0.0-beta.2-F05138)](https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.2) +[![Release: 1.0.0-beta.2](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E2-F05138)](https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.2) ## Features @@ -41,7 +41,11 @@ Then add `FeatherOpenAPI` to your target dependencies: ## Usage -[![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)] (https://feather-framework.github.io/feather-openapi/) +[ + ![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138) +]( + https://feather-framework.github.io/feather-openapi/ +) API documentation is available at the following link. From 297308b2dd3f3131f552daa0081c3bd80899ff46 Mon Sep 17 00:00:00 2001 From: Tibor Bodecs Date: Thu, 5 Feb 2026 12:08:57 +0100 Subject: [PATCH 4/4] improve readability --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12a3e45..1f4e30d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Swift in a type-safe way. -[![Release: 1.0.0-beta.2](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E2-F05138)](https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.2) +[ + ![Release: 1.0.0-beta.2](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E2-F05138) +]( + https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.2 +) ## Features