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

Updates to the apiserver swagger-ui #1410

Merged
merged 1 commit into from
Sep 11, 2023

Conversation

z103cb
Copy link
Contributor

@z103cb z103cb commented Sep 11, 2023

Fixes #1343

Why are these changes needed?

Current implementation of the Kuberay API server present the vanilla pet store implementation in the /swagger-ui/ endpoint. This PR fixes this issues.

The changes are:

  • Update the swagger version to 5.4.2
  • Added the correct swagger .json files
  • Serve the swagger.json files from the local file system when running the API server from the development machine.

Related issue number

Closes #1343

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • This PR is not tested :(

@z103cb z103cb mentioned this pull request Sep 11, 2023
4 tasks
Copy link
Contributor Author

@z103cb z103cb left a comment

Choose a reason for hiding this comment

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

@tedhtchang, @kevin85421 and @anishasthana I have closed #1387 in favour of this PR. Please take a look.

Copy link
Contributor

@blublinsky blublinsky left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@tedhtchang tedhtchang left a comment

Choose a reason for hiding this comment

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

LGTM. I verified the swagger UI working. Steps:

# run apiserver locally
make run
# Check swagger ui http://localhost:8888/swagger-ui/ in the browser

More ways to test: deploy a RayCluster using the swagger ui #1387 (review)

Copy link
Member

@kevin85421 kevin85421 left a comment

Choose a reason for hiding this comment

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

I haven't reviewed this PR, but I approved it because it only changes KubeRay API Server and it receives two approvals from IBM / RedHat folks.

@kevin85421
Copy link
Member

The RayService e2e tests are known to be flaky. It is not related with this PR. Merge this PR.

@kevin85421 kevin85421 merged commit f144145 into ray-project:master Sep 11, 2023
20 of 21 checks passed
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
Updates to the apiserver swagger-ui
@z103cb z103cb deleted the z103cb/issue1343-b branch February 5, 2024 14:36
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.

[Bug] KubeRay API Server shows the pet store swagger UI>
4 participants