feat(ws): add swagger config

[Mohamed-ben-khemis]

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.

[ederign]

/ok-to-test

[ederign]

We are on the right path. Just added some comments there:

Also, can we reduce the logs generated?

:no Go files in /Users/ederign/src/kubeflow/notebooks/workspaces/backend
2025/02/18 10:29:57 Generating health_check.HealthCheck
2025/02/18 10:29:57 Generating health_check.ServiceStatus
2025/02/18 10:29:57 Generating health_check.SystemInfo
2025/02/18 10:29:57 Generating api.ErrorResponse
2025/02/18 10:29:57 create docs.go at api/v1/swagger/docs.go
2025/02/18 10:29:57 create swagger.json at api/v1/swagger/swagger.json
2025/02/18 10:29:57 create swagger.yaml at api/v1/swagger/swagger.yaml

[ederign]

We will have to add instructions to either user install it or make sure that we install as binary. Do you think we can do similar to what we do on bin? with env test?

[ederign]

Also, other kubeflow projects "version" the file under api folder:
https://github.com/kubeflow/model-registry/tree/main/api/
https://github.com/kubeflow/pipelines/tree/master/api

Can we do the same? If we have the generated file inside our codebase we add easily to kubeflow docs.

[ederign]

Similar to https://www.kubeflow.org/docs/components/model-registry/reference/rest-api/

[ederign]

As I mention on other, my suggestion is to serialize into another folder (i.e. openapi) on root of backend

[Mohamed-ben-khemis]

Done! It's now generating into the openapi folder at the root of the backend(backend/openapi).

[ederign]

Great progress @Mohamed-ben-khemis take a look on our tests that are failing due to lack of binary.

Also, 7 warning: failed to get package name in dir: ./, error: execute go list command, exit status 1, stdout:, stderr:no Go files in /Users/ederign/src/kubeflow/notebooks/workspaces/backend

[Mohamed-ben-khemis]

We are on the right path. Just added some comments there:

Also, can we reduce the logs generated?

:no Go files in /Users/ederign/src/kubeflow/notebooks/workspaces/backend
2025/02/18 10:29:57 Generating health_check.HealthCheck
2025/02/18 10:29:57 Generating health_check.ServiceStatus
2025/02/18 10:29:57 Generating health_check.SystemInfo
2025/02/18 10:29:57 Generating api.ErrorResponse
2025/02/18 10:29:57 create docs.go at api/v1/swagger/docs.go
2025/02/18 10:29:57 create swagger.json at api/v1/swagger/swagger.json
2025/02/18 10:29:57 create swagger.yaml at api/v1/swagger/swagger.yaml

Done! I've added quiet mode to swag init

[Mohamed-ben-khemis]

Great progress @Mohamed-ben-khemis take a look on our tests that are failing due to lack of binary.

Also, 7 warning: failed to get package name in dir: ./, error: execute go list command, exit status 1, stdout:, stderr:no Go files in /Users/ederign/src/kubeflow/notebooks/workspaces/backend
Fixed swag init by adjusting directory selection. Now it properly processes Go files, excluding cmd/, and runs without warning.

[ederign]

/assign @ederign

[google-oss-prow]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ederign
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:

• OWNERS

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

[ederign]

Nice work @Mohamed-ben-khemis! This is a good starting point for our swagger generation. Let's review it on the call today with @thesuperzapper, and my suggestion would be for you to start the other endpoints!

[ederign]

/lgtm

[ederign]

Screenshot of this running:

[Mohamed-ben-khemis]

Nice work @Mohamed-ben-khemis! This is a good starting point for our swagger generation. Let's review it on the call today with @thesuperzapper, and my suggestion would be for you to start the other endpoints!

Great! Thanks for the review @ederign. Now that this is merged, I'll begin working on the other endpoints.