Skip to content

Commit 4e2d12e

Browse files
authored
Update README.md
1 parent 4834a61 commit 4e2d12e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fwei18%2Fgithub-rest-api-swift-openapi%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/wei18/github-rest-api-swift-openapi)
66

77

8-
This Swift code generator is built upon the [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator) and leverages the OpenAPI description for GitHub's REST API. The goal is to automate the creation of Swift language bindings, providing developers with a seamless way to interact with GitHub's REST API.
8+
This Swift code generator is built upon the [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator) and leverages the OpenAPI description for GitHub's REST API. The goal is to automate the creation of Swift language code, providing developers with a seamless way to interact with GitHub's REST API.
99

1010
## Usage
1111
For example you can import these frameworks to fetch github users, or see reference [UsersTests.swift](https://github.com/Wei18/github-rest-api-swift-openapi/blob/46bd7a951cd6a2bda9a9d26d843d55bb12f769c3/Tests/UsersTests/UsersTests.swift#L8-L15).
@@ -18,7 +18,6 @@ let client = Client(serverURL: try Servers.server1(), transport: URLSessionTrans
1818
let users = try await client.users_sol_list().ok.body.json
1919
```
2020

21-
2221
<details>
2322
<summary>Full Supported Framworks</summary>
2423

@@ -192,5 +191,7 @@ Wanna use Swift as the development language to create some convenient and user-f
192191
# Contributions
193192

194193
Contributions are welcome! If you encounter issues or have suggestions for improvements, feel free to open an issue or submit a pull request.
194+
195195
This repository is automatically kept up to date with the submodule [github/rest-api-description](https://github.com/github/rest-api-description).
196-
If you've identified a mismatch between GitHub API's swift code and these descriptions, or found an issue with the format of a schema, [please open an issue to github/rest-api-description](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) or [please open an issue to apple/swift-openapi-generator](https://github.com/apple/swift-openapi-generator/issues).
196+
197+
If you've identified a mismatch between GitHub API's Swift code and these descriptions, or found an issue with the format of a schema, [please open an issue to github/rest-api-description](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) or [open an issue to apple/swift-openapi-generator](https://github.com/apple/swift-openapi-generator/issues).

0 commit comments

Comments
 (0)