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

fix(openapi)!: add health endpoint to openapi #2709

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GMishx
Copy link
Member

@GMishx GMishx commented Nov 15, 2024

Please provide a summary of your changes here.

Add the missing docs for /health endpoint in OpenAPI docs. To make the changes work with Swagger UI, the /health endpoint had to be moved making it a breaking change.

BREAKING CHANGE: Move the health endpoint from /resource/health to /resource/api/health for OpenAPI documentations to be easy to use.

Suggest Reviewer

How To Test?

Check OpenAPI docs for the health endpoint.

@GMishx GMishx added needs code review needs general test This is general testing, meaning that there is no org specific issue to check for REST breaking change labels Nov 15, 2024
@GMishx GMishx force-pushed the test/docker/integration branch 2 times, most recently from c071458 to a4c173b Compare November 19, 2024 08:47
Rearrange the application.yml in test to look more like source.

BREAKING CHANGE: Move the health endpoint from `/resource/health` to
`/resource/api/health` for OpenAPI documentations to be easy to use.

Signed-off-by: Gaurav Mishra <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change needs code review needs general test This is general testing, meaning that there is no org specific issue to check for REST
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant