[Proposal] SOAR-0001 Improved OpenAPI -> Swift name mapping

[denil-ct]

Motivation

Encoding a string would help distinguish types properly. For eg. both a b and a_b would be rendered as a_b. This change would make it render a_space_b and a_b respectively. Adding a proposal as its not a trivial change, as recommended by the contribution guidelines.

Modifications

Added proposal document - SOAR-0001.md

An initial draft of the proposed implementation is at #89. Any suggestions or improvements for the proposal are welcome.

[czechboy0]

Ok, let's move this proposal into the next stage (a reminder, the proposal process is documented here, but this is the first proposal going through it, so we'll adjust as needed after this review period).

Marking this proposal as In Review, and the review period runs from today until July 10 (a little over 7 days as some of us are on vacation).

Reviewers are encouraged to leave feedback here or on the Swift forums (I'll create a post there shortly).

Thank you! 🙏

cc @denil-ct @simonjbeaumont

[czechboy0]

Forums thread: https://forums.swift.org/t/proposal-soar-0001-improved-openapi-swift-name-mapping/65890

[czechboy0]

Changed the label and you can change the PR to a draft for now, @denil-ct 🙏

Details: https://forums.swift.org/t/proposal-on-hold-soar-0001-improved-openapi-swift-name-mapping/65890/21

[czechboy0]

This proposal is back In Review, for details see https://forums.swift.org/t/proposal-in-review-soar-0001-improved-openapi-swift-name-mapping/65890/22

[czechboy0]

This proposal has been moved forward to Ready for Implementation: https://forums.swift.org/t/proposal-in-review-soar-0001-improved-openapi-swift-name-mapping/65890/23

[denil-ct]

Shall I mark this PR as ready for review then?

[czechboy0]

Sure, but we'll land it with the status updated to Accepted only once the impl PR lands as well.

[denil-ct]

Ah okay. Then let it be in draft.

[czechboy0]

Ok, the PR #89 landed, so the feature is in main, disabled by default, hidden behind the feature flag proposal0001.

Let me see if we should update the proposal template, to add a field for feature flags, to have a state for "in main but disabled behind a feature flag".

[czechboy0]

Proposing here: #161

That'd allow us to move this proposal to that state, and merge this PR. We'd update the status to Accepted once the feature flag is enabled in 0.2.0.

[czechboy0]

@denil-ct Okay, so we have a new proposal field and state, landed in #161

Can you update your proposal by adding the feature flag name as a field to the top, and changing the state to In Preview? Then we'll be able to land this.