Generate API models with openapi-generator plugin in new module#992
Merged
bherbst merged 1 commit intothe-blue-alliance:masterfrom Jan 18, 2025
Merged
Generate API models with openapi-generator plugin in new module#992bherbst merged 1 commit intothe-blue-alliance:masterfrom
bherbst merged 1 commit intothe-blue-alliance:masterfrom
Conversation
This was referenced Jan 18, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary:
Our API models are woefully out of date, and unfortunately I have not had success regenerating our models using the existing infrastructure.
The existing tooling relies on a fork of swagger-codegen that generates interfaces instead of concrete Java classes.
This fork was made when the latest version of swagger specs was 2.0, but TBA's API specs now leverage OpenAPI spec version 3.0.1.
In theory we could bring our swagger-codegen fork up to date with upstream, however there are a few reasons I'm not pursuing that:
This PR only creates a new
tba-apimodule with models and Retrofit interfaces generated by openapi-generator. This PR does not change any existing code to leverage the newly generated modules, and we will need to work our way through the existing codebase to migrate. I plan to do this in small chunks, roughly one at a time as possible.