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

Upgrade to OpenAPI v3 #196

Open
2 tasks done
michaeladler opened this issue Jul 18, 2024 · 0 comments
Open
2 tasks done

Upgrade to OpenAPI v3 #196

michaeladler opened this issue Jul 18, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@michaeladler
Copy link
Member

michaeladler commented Jul 18, 2024

Description

  • Migrate our spec from Swagger to OpenAPI v3
  • Adapt the code generation process to use the newly upgraded spec (go-openapi doesn't support OpenAPI v3)

Motivation

Upgrading from Swagger to OpenAPI v3 offers numerous benefits, including enhanced specification features, better support for modern use cases, improved developer experience, access to a richer ecosystem and tooling, future-proofing our API specifications, and ensuring compliance and interoperability. These advantages make a compelling case for undertaking the upgrade to OpenAPI v3, and we recommend proceeding with this transition to realize these benefits for our project.

Proposed Solution (optional)

These are the candidates for code generation:

Note that we have a special requirement: the /jobs/events API is streaming (server-sent events).
Currently, it is not possible to use ogen for that purpose because it utilizes io.ReadAll under the hood.
For more details, see this issue.

@michaeladler michaeladler added the enhancement New feature or request label Jul 18, 2024
@michaeladler michaeladler self-assigned this Jul 18, 2024
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

When branches are created from issues, their pull requests are automatically linked.

1 participant