Skip to content

Commit b5acdd0

Browse files
Proposal documentation cleanup and consistency (#469)
### Motivation We want to go into 1.0 with the proposal documentation up to date, w.r.t. the version in which the proposal was implemented, and linking to the forums post where they were reviewed. They also have diverged a bit in style. ### Modifications Update the proposal docs for consistent style. I referred again to the style used in the Swift Evolution repo. ### Result Proposal docs consistent and up to date. ### Test Plan None.
1 parent c70be84 commit b5acdd0

File tree

8 files changed

+36
-79
lines changed

8 files changed

+36
-79
lines changed

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,12 @@ Improved mapping of OpenAPI identifiers to Swift identifiers.
55
## Overview
66

77
- Proposal: SOAR-0001
8-
- Author(s): [Denil](https://github.com/denil-ct)
9-
- Status: **Accepted, available since 0.2.0.**
8+
- Author(s): [Denil Chungath](https://github.com/denil-ct)
9+
- Status: **Implemented (0.2.0)**
1010
- Issue: https://github.com/apple/swift-openapi-generator/issues/21
11-
- Implementation:
12-
- https://github.com/apple/swift-openapi-generator/pull/89
13-
- Feature flag: `proposal0001`
14-
- Affected components:
15-
- generator
11+
- Implementation: https://github.com/apple/swift-openapi-generator/pull/89
12+
- Review: ([review](https://forums.swift.org/t/proposal-ready-for-implementation-soar-0001-improved-openapi-swift-name-mapping/65890))
13+
- Affected components: generator
1614

1715
### Introduction
1816

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@ Improved naming of content types to Swift identifiers.
66

77
- Proposal: SOAR-0002
88
- Author(s): [Honza Dvorsky](https://github.com/czechboy0)
9-
- Status: **Accepted, available since 0.2.0.**
9+
- Status: **Implemented (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)
11-
- Implementation:
12-
- [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)
13-
- Feature flag: `multipleContentTypes`
14-
- Affected components:
15-
- generator
11+
- Implementation: [apple/swift-openapi-generator#146](https://github.com/apple/swift-openapi-generator/pull/146)
12+
- Review: ([review](https://forums.swift.org/t/proposal-soar-0002-improved-naming-of-content-types/66620))
13+
- Affected components: generator
1614
- Versions:
1715
- v1 (2023-08-07): First draft
1816
- v2 (2023-08-08): Second draft with the following changes:

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,11 @@ 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: **Accepted, available since 0.2.0.**
9+
- Status: **Implemented (0.2.0)**
1010
- Issue: [apple/swift-openapi-generator#160](https://github.com/apple/swift-openapi-generator/issues/160)
11-
- Implementation:
12-
- [apple/swift-openapi-runtime#37](https://github.com/apple/swift-openapi-runtime/pull/37)
13-
- [apple/swift-openapi-generator#185](https://github.com/apple/swift-openapi-generator/pull/185)
14-
- Feature flag: `multipleContentTypes`
15-
- Affected components:
16-
- generator
17-
- runtime
11+
- Implementation: [apple/swift-openapi-runtime#37](https://github.com/apple/swift-openapi-runtime/pull/37), [apple/swift-openapi-generator#185](https://github.com/apple/swift-openapi-generator/pull/185)
12+
- Review: ([review](https://forums.swift.org/t/proposal-soar-0003-type-safe-accept-headers/66785))
13+
- Affected components: generator, runtime
1814

1915
### Introduction
2016

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

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,11 @@ 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: **Accepted, available since 0.3.0.**
9+
- Status: **Implemented (0.3.0)**
1010
- Issue: [apple/swift-openapi-generator#9](https://github.com/apple/swift-openapi-generator/issues/9)
11-
- Implementation:
12-
- [apple/swift-openapi-generator#245](https://github.com/apple/swift-openapi-generator/pull/245)
13-
- [apple/swift-openapi-runtime#47](https://github.com/apple/swift-openapi-runtime/pull/47)
14-
- [apple/swift-openapi-urlsession#15](https://github.com/apple/swift-openapi-urlsession/pull/15)
15-
- [swift-server/swift-openapi-async-http-client#16](https://github.com/swift-server/swift-openapi-async-http-client/pull/16)
16-
- Feature flag: none, lands as a breaking change to main, gets released as 0.3.0
17-
- Affected components:
18-
- generator
19-
- runtime
20-
- client transports
21-
- server transports
11+
- Implementation: [apple/swift-openapi-generator#245](https://github.com/apple/swift-openapi-generator/pull/245), [apple/swift-openapi-runtime#47](https://github.com/apple/swift-openapi-runtime/pull/47), [apple/swift-openapi-urlsession#15](https://github.com/apple/swift-openapi-urlsession/pull/15), [swift-server/swift-openapi-async-http-client#16](https://github.com/swift-server/swift-openapi-async-http-client/pull/16)
12+
- Review: ([review](https://forums.swift.org/t/proposal-soar-0004-streaming-request-and-response-bodies/67184))
13+
- Affected components: generator, runtime, client transports, server transports
2214
- Versions:
2315
- v1 (2023-09-08): Initial version
2416
- v1.1: Make HTTPBody.Iterator.next() mutating

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

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,11 @@ 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: **Accepted, available since 0.3.0.**
9+
- Status: **Implemented (0.3.0)**
1010
- Issue: [apple/swift-openapi-generator#101](https://github.com/apple/swift-openapi-generator/issues/101)
11-
- Implementation:
12-
- [apple/swift-openapi-generator#245](https://github.com/apple/swift-openapi-generator/pull/245)
13-
- [apple/swift-openapi-runtime#47](https://github.com/apple/swift-openapi-runtime/pull/47)
14-
- [apple/swift-openapi-urlsession#15](https://github.com/apple/swift-openapi-urlsession/pull/15)
15-
- [swift-server/swift-openapi-async-http-client#16](https://github.com/swift-server/swift-openapi-async-http-client/pull/16)
16-
- Feature flag: none, lands as a breaking change to main, gets released as 0.3.0
17-
- Affected components:
18-
- generator
19-
- runtime
20-
- client transports
21-
- server transports
11+
- Implementation: [apple/swift-openapi-generator#245](https://github.com/apple/swift-openapi-generator/pull/245), [apple/swift-openapi-runtime#47](https://github.com/apple/swift-openapi-runtime/pull/47), [apple/swift-openapi-urlsession#15](https://github.com/apple/swift-openapi-urlsession/pull/15), [swift-server/swift-openapi-async-http-client#16](https://github.com/swift-server/swift-openapi-async-http-client/pull/16)
12+
- Review: ([review](https://forums.swift.org/t/proposal-soar-0005-adopting-the-swift-http-types-package/67185))
13+
- Affected components: generator, runtime, client transports, server transports
2214
- Versions:
2315
- v1 (2023-09-08): Initial version
2416
- v1.1: In `ServerTransport` and `ServerMiddleware`, make the response `HTTPBody` optional to preserve the intent of the OpenAPI document author for the transport.

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

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,13 @@ operation outputs.
77

88
- Proposal: SOAR-0007
99
- Author(s): [Si Beaumont](https://github.com/simonjbeaumont)
10-
- Status: **Accepted, available since 0.3.0.**
10+
- Status: **Implemented (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)
13-
- Issue:
14-
- [apple/swift-openapi-generator#22](https://github.com/apple/swift-openapi-generator/issues/22)
15-
- [apple/swift-openapi-generator#104](https://github.com/apple/swift-openapi-generator/issues/104)
16-
- [apple/swift-openapi-generator#105](https://github.com/apple/swift-openapi-generator/issues/105)
17-
- [apple/swift-openapi-generator#145](https://github.com/apple/swift-openapi-generator/issues/145)
18-
- Implementation:
19-
- [apple/swift-openapi-runtime#56](https://github.com/apple/swift-openapi-runtime/pull/56)
20-
- [apple/swift-openapi-generator#308](https://github.com/apple/swift-openapi-generator/pull/308)
21-
- Feature flag: none
22-
- Affected components:
23-
- generator
24-
- runtime
13+
- Issue: [apple/swift-openapi-generator#22](https://github.com/apple/swift-openapi-generator/issues/22), [apple/swift-openapi-generator#104](https://github.com/apple/swift-openapi-generator/issues/104), [apple/swift-openapi-generator#105](https://github.com/apple/swift-openapi-generator/issues/105), [apple/swift-openapi-generator#145](https://github.com/apple/swift-openapi-generator/issues/145)
14+
- Implementation: [apple/swift-openapi-runtime#56](https://github.com/apple/swift-openapi-runtime/pull/56), [apple/swift-openapi-generator#308](https://github.com/apple/swift-openapi-generator/pull/308)
15+
- Review: ([review](https://forums.swift.org/t/proposal-soar-0007-shorthand-apis-for-inputs-and-outputs/67444))
16+
- Affected components: generator, runtime
2517
- Related links:
2618
- [Project scope and goals](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/project-scope-and-goals)
2719
- Versions:

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

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,11 @@ Filtering the OpenAPI document for just the required parts prior to generating.
66

77
- Proposal: SOAR-0008
88
- Author(s): [Si Beaumont](https://github.com/simonjbeaumont)
9-
- Status: **Accepted, available since 0.3.1.**
10-
- Review period: 2023-09-28 – 2023-10-05
11-
- [Swift Forums post](https://forums.swift.org/t/proposal-soar-0008-openapi-document-filtering/67574)
12-
- Issue:
13-
- [apple/swift-openapi-generator#285](https://github.com/apple/swift-openapi-generator/issues/285)
14-
- Implementation:
15-
- [apple/swift-openapi-generator#319](https://github.com/apple/swift-openapi-generator/pull/319)
16-
- Feature flag: n/a
17-
- Affected components:
18-
- generator
9+
- Status: **Implemented (0.3.0)**
10+
- Issue: [apple/swift-openapi-generator#285](https://github.com/apple/swift-openapi-generator/issues/285)
11+
- Implementation: [apple/swift-openapi-generator#319](https://github.com/apple/swift-openapi-generator/pull/319)
12+
- Review: ([review](https://forums.swift.org/t/proposal-soar-0008-openapi-document-filtering/67574))
13+
- Affected components: generator
1914
- Related links:
2015
- [Project scope and goals](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/project-scope-and-goals)
2116
- Versions:

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

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,12 @@ Provide a type-safe streaming API to produce and consume multipart bodies.
66

77
- Proposal: SOAR-0009
88
- Author(s): [Honza Dvorsky](https://github.com/czechboy0)
9-
- Status: **Accepted, available since 1.0.0-alpha.1**
10-
- Review period: 2023-11-08 – 2023-11-15
11-
- [Swift Forums post](https://forums.swift.org/t/proposal-soar-0009-type-safe-streaming-multipart-support/68331)
9+
- Status: **Implemented (1.0.0)**
1210
- Issue: [apple/swift-openapi-generator#36](https://github.com/apple/swift-openapi-generator/issues/36)
13-
- Implementation:
14-
- [apple/swift-openapi-runtime#69](https://github.com/apple/swift-openapi-runtime/pull/69)
15-
- [apple/swift-openapi-generator#366](https://github.com/apple/swift-openapi-generator/pull/366)
16-
- Feature flag: none
17-
- Affected components:
18-
- generator
19-
- runtime
20-
- Links:
11+
- Implementation: [apple/swift-openapi-runtime#69](https://github.com/apple/swift-openapi-runtime/pull/69), [apple/swift-openapi-generator#366](https://github.com/apple/swift-openapi-generator/pull/366)
12+
- Review: ([review](https://forums.swift.org/t/proposal-soar-0009-type-safe-streaming-multipart-support/68331))
13+
- Affected components: generator, runtime
14+
- Related links:
2115
- [OpenAPI 3.0.3 specification][openapi303]
2216
- [OpenAPI 3.1.0 specification][openapi310]
2317
- [Swagger.io documentation on multipart support in OpenAPI 3.x][swaggerio-multipart]

0 commit comments

Comments
 (0)