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

feat(ws): add swagger config #206

Open
wants to merge 7 commits into
base: notebooks-v2
Choose a base branch
from

Conversation

Mohamed-ben-khemis
Copy link

@Mohamed-ben-khemis Mohamed-ben-khemis commented Feb 12, 2025

Closes #46

Summary

This PR introduces Swagger configuration for the project, enabling API documentation and interactive testing directly from the browser.

Changes Implemented

  • Swagger Setup: Initialized and configured Swagger for the backend.
  • Document Health Check: Added Swagger documentation for the health check endpoint.
  • Ensure Swagger Docs Regeneration: Ensured Swagger documentation is regenerated before each backend build and run.
  • Structured Documentation Output: Configured JSON/YAML documentation output to be stored in api/v1/swagger.
  • Serving API Documentation:
    • Enabled serving the generated YAML documentation in addition to the Swagger UI.

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kimwnasptd for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Mohamed-ben-khemis Mohamed-ben-khemis changed the title feat(ws:) feat(ws): add swagger config Feb 12, 2025
Signed-off-by: mohamed-ben-khemis <[email protected]>
Signed-off-by: mohamed-ben-khemis <[email protected]>
Signed-off-by: mohamed-ben-khemis <[email protected]>
Signed-off-by: mohamed-ben-khemis <[email protected]>
Signed-off-by: mohamed-ben-khemis <[email protected]>
Signed-off-by: mohamed-ben-khemis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

1 participant