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

Update the horreum-api definition #2318

Merged
merged 1 commit into from
Mar 28, 2025

Conversation

lampajr
Copy link
Member

@lampajr lampajr commented Mar 25, 2025

This is a big change but it shouldn't have any impact on external users as the API did NOT change.
The UI will be affected by this, therefore we should check that all functionalities are still working.

Fixes Issue

Fixes #2317

Changes proposed

  • Re-enable the openapi TS client generation validation
  • Remove python/go client generation as not needed here
  • Update the horreum-api schemas definition
  • Update the horreum-api services definition
  • Update the UI accordingly
  • Removed the allOf from all schemas

NOTE: the exposed API did NOT change!
NOTE: what would change is the client generation as the method names will change accordingly to the methods names in the horreum-api services

Check List (Check all the applicable boxes)

  • My code follows the code style of this project.
  • My change requires changes to the documentation.
  • I have updated the documentation accordingly.
  • All new and existing tests passed.

Signed-off-by: Andrea Lamparelli <[email protected]>
@lampajr lampajr marked this pull request as ready for review March 25, 2025 15:59
@lampajr
Copy link
Member Author

lampajr commented Mar 25, 2025

Tested locally and it looks good to me but I'd like to have another pair of eyes checking it 👀

@lampajr
Copy link
Member Author

lampajr commented Mar 25, 2025

Removed the allOf from all schemas

I did this because given that our source of truth is horreum-api module (i.e., java code) I think they are not actually needed, especially because the client generation would be the same even without that allOf. With this the generated openapi spec is simpler w/o such allOf

@lampajr lampajr self-assigned this Mar 27, 2025
@stalep stalep merged commit e40ecfc into Hyperfoil:master Mar 28, 2025
3 checks passed
@lampajr lampajr deleted the fix_openapi_errors branch March 28, 2025 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The openapi generator is currently logging some errors
2 participants