apple / swift-openapi-generator

Generate Swift client and server code from an OpenAPI document.
https://swiftpackageindex.com/apple/swift-openapi-generator/documentation
Apache License 2.0
1.45k stars 120 forks source link

Add a note about an open issue with code generation and SourceKit-LSP #642

Open t089 opened 1 month ago

t089 commented 1 month ago

Following the discussion on Slack, this adds a note for users of SourceKit-LSP informing them that the default code generation might not work as expected and offers a possible workaround.

https://swift-open-source.slack.com/archives/C02PV8T5HQD/p1726815970093299

Only updates documentation. Let me know if you feel this is the right place for this information?

simonjbeaumont commented 1 month ago

Thanks for putting this up.

IMO I think we should move this to the Supported platforms and minimum versions section, since that's where we're explaining the required runtime and development environments. This is additional note on Editor Support.

Additionally, we try to keep the README and root DocC page in sync. Would you be able to update both?

t089 commented 11 hours ago

Sorry forgot about this one, updated the PR. CC @simonjbeaumont