Skip to content

Commit a692897

Browse files
authored
[Docs] Document Android support (#852)
### Motivation See apple/swift-openapi-runtime#163. ### Modifications Updated the supported platforms in docs to include Android. Also removed tracking the last Swift version, as we haven't been keeping that up to date, so it was stale. ### Result Docs representing that Swift OpenAPI Generator can be used for Android projects. ### Test Plan N/A
1 parent c4f3f1e commit a692897

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@ The generator is used during development and is supported on macOS, Linux, and W
104104
The generated code, runtime library, and transports are supported on more
105105
platforms, listed below.
106106

107-
| Component | macOS | Linux, Windows | iOS | tvOS | watchOS | visionOS |
108-
| ----------------------------------: | :--- | :--- | :- | :-- | :----- | :------ |
109-
| Generator plugin and CLI | ✅ 10.15+ || ✖️ | ✖️ | ✖️ | ✖️ |
110-
| Generated code and runtime library | ✅ 10.15+ || ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ |
107+
| Component | macOS | Linux, Windows | iOS | tvOS | watchOS | visionOS | Android |
108+
| ----------------------------------: | :--- | :------------ | :- | :-- | :----- | :------ | :------ |
109+
| Generator plugin and CLI | ✅ 10.15+ | | ✖️ | ✖️ | ✖️ | ✖️ | ✖️ |
110+
| Generated code and runtime library | ✅ 10.15+ | | ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ | |
111111

112112
## Documentation and example projects
113113

Sources/swift-openapi-generator/Documentation.docc/Swift-OpenAPI-Generator.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ The Swift OpenAPI Generator project is split across multiple repositories to ena
9090

9191
### Requirements and supported features
9292

93-
| Generator versions | Supported OpenAPI versions | Minimum Swift version |
94-
| ------------------ | --------------------------- | --------------------- |
95-
| `1.0.0` ... `main` | 3.0, 3.1, 3.2 (preliminary) | 5.9 |
93+
| Generator versions | Supported OpenAPI versions |
94+
| ------------------ | --------------------------- |
95+
| `1.0.0` ... `main` | 3.0, 3.1, 3.2 (preliminary) |
9696

9797
See also <doc:Supported-OpenAPI-features>.
9898

@@ -102,10 +102,10 @@ The generator is used during development and is supported on macOS and Linux.
102102

103103
The generated code, runtime library, and transports are supported on more platforms, listed below.
104104

105-
| Component | macOS | Linux | iOS | tvOS | watchOS | visionOS |
106-
| ----------------------------------: | :--- | :--- | :- | :-- | :----- | :------ |
107-
| Generator plugin and CLI | ✅ 10.15+ || ✖️ | ✖️ | ✖️ | ✖️ |
108-
| Generated code and runtime library | ✅ 10.15+ || ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ |
105+
| Component | macOS | Linux | iOS | tvOS | watchOS | visionOS | Android |
106+
| ----------------------------------: | :--- | :--- | :- | :-- | :----- | :------ | :------ |
107+
| Generator plugin and CLI | ✅ 10.15+ || ✖️ | ✖️ | ✖️ | ✖️ | ✖️ |
108+
| Generated code and runtime library | ✅ 10.15+ || ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ | |
109109

110110
> Note: When using Visual Studio Code or other editors that rely on [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp), the editor may not correctly recognize generated code within the same module. As a workaround, consider creating a separate target for code generation and then importing it into your main module. For more details, see the discussion in [swiftlang/sourcekit-lsp#665](https://github.com/swiftlang/sourcekit-lsp/issues/665#issuecomment-2093169169).
111111

0 commit comments

Comments
 (0)