Skip to content

Commit c67892a

Browse files
Add proposal SOAR-0008: OpenAPI document filtering (#303)
### Motivation We'd like to run a proposal for filtering the OpenAPI document for just the required parts prior to generating. ### Modifications - Add SOAR-0008: OpenAPI document filtering (See the proposal itself for details)[^1] ### Result n/a ### Test Plan n/a ### Related Issues #285 [^1]: https://github.com/apple/swift-openapi-generator/pull/303/files --------- Signed-off-by: Si Beaumont <[email protected]>
1 parent ac830c1 commit c67892a

File tree

8 files changed

+498
-6
lines changed

8 files changed

+498
-6
lines changed

Sources/swift-openapi-generator/Documentation.docc/Proposals/Proposals.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,4 @@ If you have any questions, tag [Honza Dvorsky](https://github.com/czechboy0) or
4949
- <doc:SOAR-0004>
5050
- <doc:SOAR-0005>
5151
- <doc:SOAR-0007>
52+
- <doc:SOAR-0008>

Sources/swift-openapi-generator/Documentation.docc/Proposals/SOAR-0001.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Improved mapping of OpenAPI identifiers to Swift identifiers.
66

77
- Proposal: SOAR-0001
88
- Author(s): [Denil](https://github.com/denil-ct)
9-
- Status: **In Preview**
9+
- Status: **Accepted, available since 0.2.0.**
1010
- Issue: https://github.com/apple/swift-openapi-generator/issues/21
1111
- Implementation:
1212
- https://github.com/apple/swift-openapi-generator/pull/89

Sources/swift-openapi-generator/Documentation.docc/Proposals/SOAR-0002.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Improved naming of content types to Swift identifiers.
66

77
- Proposal: SOAR-0002
88
- Author(s): [Honza Dvorsky](https://github.com/czechboy0)
9-
- Status: **In Preview**
9+
- Status: **Accepted, available since 0.2.0.**
1010
- Issue: N/A, was part of multiple content type support: [apple/swift-openapi-generator#6](https://github.com/apple/swift-openapi-generator/issues/6) and [apple/swift-openapi-generator#7](https://github.com/apple/swift-openapi-generator/issues/7)
1111
- Implementation:
1212
- [Landed behind a feature flag as part of apple/swift-openapi-generator#146](https://github.com/czechboy0/swift-openapi-generator/blob/4555f8e998b24aa65a462a63828d9195c50dcc23/Sources/_OpenAPIGeneratorCore/Translator/Content/ContentSwiftName.swift#L23-L42)

Sources/swift-openapi-generator/Documentation.docc/Proposals/SOAR-0003.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Generate a dedicated Accept header enum for each operation.
66

77
- Proposal: SOAR-0003
88
- Author(s): [Honza Dvorsky](https://github.com/czechboy0), [Si Beaumont](https://github.com/simonjbeaumont)
9-
- Status: **In Preview**
9+
- Status: **Accepted, available since 0.2.0.**
1010
- Issue: [apple/swift-openapi-generator#160](https://github.com/apple/swift-openapi-generator/issues/160)
1111
- Implementation:
1212
- [apple/swift-openapi-runtime#37](https://github.com/apple/swift-openapi-runtime/pull/37)

Sources/swift-openapi-generator/Documentation.docc/Proposals/SOAR-0004.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Represent HTTP request and response bodies as a stream of bytes.
66

77
- Proposal: SOAR-0004
88
- Author(s): [Honza Dvorsky](https://github.com/czechboy0)
9-
- Status: **Ready for Implementation**
9+
- Status: **Accepted, available since 0.3.0.**
1010
- Issue: [apple/swift-openapi-generator#9](https://github.com/apple/swift-openapi-generator/issues/9)
1111
- Implementation:
1212
- [apple/swift-openapi-generator#245](https://github.com/apple/swift-openapi-generator/pull/245)

Sources/swift-openapi-generator/Documentation.docc/Proposals/SOAR-0005.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Adopt the new ecosystem-wide Swift HTTP Types package for HTTP currency types in
66

77
- Proposal: SOAR-0005
88
- Author(s): [Honza Dvorsky](https://github.com/czechboy0)
9-
- Status: **Ready for Implementation**
9+
- Status: **Accepted, available since 0.3.0.**
1010
- Issue: [apple/swift-openapi-generator#101](https://github.com/apple/swift-openapi-generator/issues/101)
1111
- Implementation:
1212
- [apple/swift-openapi-generator#245](https://github.com/apple/swift-openapi-generator/pull/245)

Sources/swift-openapi-generator/Documentation.docc/Proposals/SOAR-0007.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ operation outputs.
77

88
- Proposal: SOAR-0007
99
- Author(s): [Si Beaumont](https://github.com/simonjbeaumont)
10-
- Status: **Implemented**
10+
- Status: **Accepted, available since 0.3.0.**
1111
- Review period: 2023-09-22 – 2023-09-29
1212
- [Swift Forums post](https://forums.swift.org/t/proposal-soar-0007-shorthand-apis-for-inputs-and-outputs/67444)
1313
- Issue:

0 commit comments

Comments
 (0)