Skip to content

Conversation

@najuna-brian
Copy link
Contributor

Add Swagger UI Integration

Adds interactive API documentation at /openapi/swagger. Closes #21

  • Serves Swagger UI from /openapi route
  • Redirects /openapi/swagger to /openapi/swagger-ui.html
  • Updates Dockerfile to include openapi directory

All tests pass.

Test Swagger UI endpoints locally

curl http://localhost/openapi/swagger or curl http://localhost/openapi/swagger-ui.html

@najuna-brian
Copy link
Contributor Author

Hi @r0ssing , @Ndacyayisenga-droid,

There is a CI/CD build failure is due to an invalid Docker tag format (unrelated to this PR). The SHA tag generation on line 70 creates tags starting with a dash (:-035e261), which is invalid.

Suggested fix: Update line 70 to use a fixed prefix and exclude PRs:

type=sha,prefix=sha-,enable=${{ github.event_name != 'release' && github.event_name != 'pull_request' }}

PRs already get pr-22 tags, so SHA tagging can be skipped for them.

@najuna-brian najuna-brian requested a review from r0ssing November 28, 2025 17:40
@najuna-brian najuna-brian marked this pull request as ready for review November 28, 2025 18:30
Copy link
Contributor

@r0ssing r0ssing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!
And thanks for fixing the pipeline as well - this is the first "official" merge we do from a PR! 🥇 🥳

@r0ssing
Copy link
Contributor

r0ssing commented Nov 29, 2025

Not sure what practice we should follow - but I've have approved the PR, then I will leave it for you to merge (or rebase) - we can discuss the best approach at our next weekly meeting 🗣️

@najuna-brian
Copy link
Contributor Author

Thanks @r0ssing,

we can discuss the best approach at our next weekly meeting 🗣️

We may be shall merge the PR during our meeting or after it? 😃

@najuna-brian najuna-brian merged commit 747c4ed into OpenDataEnsemble:develop Dec 3, 2025
1 check passed
@najuna-brian
Copy link
Contributor Author

We may be shall merge the PR during our meeting or after it? 😃

Now merged after meeting

@najuna-brian najuna-brian deleted the feature/swagger-ui-integration branch December 9, 2025 18:50
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.

2 participants