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

Generate Java API Client for Intelligence Service's OpenAPI Specifications #33

Open
FelixTJDietrich opened this issue Aug 6, 2024 · 0 comments · May be fixed by #106
Open

Generate Java API Client for Intelligence Service's OpenAPI Specifications #33

FelixTJDietrich opened this issue Aug 6, 2024 · 0 comments · May be fixed by #106

Comments

@FelixTJDietrich
Copy link
Collaborator

FelixTJDietrich commented Aug 6, 2024

Is your feature request related to a problem? Please describe.

We want to ensure that the application server and intelligence service are able to communicate with each other using the OpenAPI specifications without a lot of manual overhead.

Describe the solution you'd like

  • Similarly to the application server, store the OpenAPI specifications in the intelligence service directory.
  • Generate the Java client for the application server using the OpenAPI specifications.
  • Add a root level package.json script to generate the Java client for the intelligence service.
  • Create a github action workflow if necessary that fails if the Java client is not up-to-date with the OpenAPI specifications.

Describe alternatives you've considered

  • Manually keeping the Java client up-to-date with the OpenAPI specifications.
  • Using gRPC instead of OpenAPI specifications, but I think OpenAPI specifications are more widely used and understood.
@FelixTJDietrich FelixTJDietrich added this to the Initial Project Setup milestone Aug 6, 2024
@FelixTJDietrich FelixTJDietrich changed the title Generate Java Client for Intelligence Service OpenAPI Specifications Generate Java API Client for Intelligence Service's OpenAPI Specifications Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants