Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish an OpenAPI document describing the Swift.org API #832

Open
czechboy0 opened this issue Oct 20, 2024 · 1 comment · May be fixed by #841
Open

Publish an OpenAPI document describing the Swift.org API #832

czechboy0 opened this issue Oct 20, 2024 · 1 comment · May be fixed by #841
Labels
enhancement New feature or request

Comments

@czechboy0
Copy link
Member

Is your feature request related to a problem? Please describe

Tools that inspect the published list of releases, such as swiftly, need to manually maintain their Swift code for calling the API endpoints and parsing responses, such as: https://github.com/swiftlang/swiftly/blob/main/Sources/SwiftlyCore/HTTPClient.swift

As the Swift.org API evolves, keeping all clients in sync by hand is error-prone and time-consuming.

Describe the solution you'd like

We should publish an OpenAPI document describing the Swift.org API, allowing clients to generate their type-safe code easily in any languages using OpenAPI code generators, such as swift-openapi-generator.

Describe alternatives you've considered

Continue maintaining clients by hand, but that doesn't seem to be a good long term strategy.

Additional context

N/A

@czechboy0
Copy link
Member Author

PR: #841

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant