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

Serve SwaggerUI #6989

Conversation

feloy
Copy link
Contributor

@feloy feloy commented Jul 20, 2023

What type of PR is this:

/kind feature

What does this PR do / why we need it:

Serve a swagger ui from odo dev / odo api-server

Instructions from:
https://ribice.medium.com/serve-swaggerui-within-your-golang-application-5486748a5ed4

Which issue(s) this PR fixes:

Fixes #6986

PR acceptance criteria:

  • Unit test

  • Integration test

  • Documentation

How to test changes / Special notes to the reviewer:

@netlify
Copy link

netlify bot commented Jul 20, 2023

🔨 Deploy Preview deleted from internal cluster!

Name Link
🔨 Latest commit 94bb453
😎 Deploy Preview https://odo-dev-pr-6989.odo-test-kubernete-449701-49529fc6e6a4a9fe7ebba9a3db5b55c4-0000.eu-de.containers.appdomain.cloud/

@openshift-ci openshift-ci bot added the kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation label Jul 20, 2023
@feloy feloy requested review from kadel and rm3l July 20, 2023 09:36
@openshift-ci openshift-ci bot requested a review from valaparthvi July 20, 2023 09:36
@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

OpenShift Unauthenticated Tests on commit ca31923 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

NoCluster Tests on commit ca31923 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

Unit Tests on commit ca31923 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

Validate Tests on commit ca31923 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

Windows Tests (OCP) on commit ca31923 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

OpenShift Tests on commit ca31923 finished with errors.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

Kubernetes Tests on commit ca31923 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 20, 2023

Kubernetes Docs Tests on commit fadd130 finished successfully.
View logs: TXT HTML

Copy link
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

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

As discussed also, we'll need to add a simple page on odo.dev (under "Advanced Usage") mentioning the API Server and the Swagger UI.

Makefile Show resolved Hide resolved
Makefile Show resolved Hide resolved
@feloy feloy force-pushed the feature-6986/embedded-swagger-ui branch from a79acd7 to f6fc692 Compare July 20, 2023 14:22
@feloy feloy temporarily deployed to internal July 20, 2023 14:22 — with GitHub Actions Inactive
@feloy feloy temporarily deployed to internal July 20, 2023 14:36 — with GitHub Actions Inactive
@feloy feloy temporarily deployed to internal July 21, 2023 06:56 — with GitHub Actions Inactive
@sonarcloud
Copy link

sonarcloud bot commented Jul 21, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

No Coverage information No Coverage information
0.0% 0.0% Duplication

@feloy feloy requested review from rm3l and removed request for valaparthvi and kadel July 21, 2023 06:57
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jul 21, 2023
@rm3l
Copy link
Member

rm3l commented Jul 21, 2023

/test odo-ocp4.14-lp-interop-images

@rm3l
Copy link
Member

rm3l commented Jul 21, 2023


Summarizing 2 Failures:
  [FAIL] odo create/delete/list/set namespace/project tests when namespace is created with -w [It] should list the new namespace when listing namespace
  /go/odo_1/tests/integration/cmd_namespace_test.go:38
  [FAIL] odo devfile deploy command tests when starting with Devfile with autoBuild or deployByDefault components when running odo deploy with some components not referenced in the Devfile [BeforeEach] should create the appropriate resources
  /go/odo_1/tests/helper/helper_cmd_wrapper.go:101

Ran 406 of 956 Specs in 1463.962 seconds
FAIL! -- 404 Passed | 2 Failed | 0 Pending | 550 Skipped
 [odo]  ✗  failed to create service(s) associated with the component: pods "k8s-deploybydefault-true-and-referenced" is forbidden: error looking up service account cmd-devfile-deploy-test723cyz/default: serviceaccount "default" not found

Unrelated issue (hopefully temporary) - but let's keep an eye on this..

odo create/delete/list/set namespace/project tests when namespace is created with -w [It] should list the new namespace when listing namespace
/go/odo_1/tests/integration/cmd_namespace_test.go:36
...
  to contain substring
      <string>: cmd-namespace-test36csz
  In [It] at: /go/odo_1/tests/integration/cmd_namespace_test.go:38 @ 07/21/23 07:21:41.626

Unrelated issue with odo list namespace tests (already reported in #6966)

/override OpenShift-Integration-tests/OpenShift-Integration-tests

@openshift-ci
Copy link

openshift-ci bot commented Jul 21, 2023

@rm3l: Overrode contexts on behalf of rm3l: OpenShift-Integration-tests/OpenShift-Integration-tests

In response to this:


Summarizing 2 Failures:
 [FAIL] odo create/delete/list/set namespace/project tests when namespace is created with -w [It] should list the new namespace when listing namespace
 /go/odo_1/tests/integration/cmd_namespace_test.go:38
 [FAIL] odo devfile deploy command tests when starting with Devfile with autoBuild or deployByDefault components when running odo deploy with some components not referenced in the Devfile [BeforeEach] should create the appropriate resources
 /go/odo_1/tests/helper/helper_cmd_wrapper.go:101

Ran 406 of 956 Specs in 1463.962 seconds
FAIL! -- 404 Passed | 2 Failed | 0 Pending | 550 Skipped
[odo]  ✗  failed to create service(s) associated with the component: pods "k8s-deploybydefault-true-and-referenced" is forbidden: error looking up service account cmd-devfile-deploy-test723cyz/default: serviceaccount "default" not found

Unrelated issue (hopefully temporary) - but let's keep an eye on this..

odo create/delete/list/set namespace/project tests when namespace is created with -w [It] should list the new namespace when listing namespace
/go/odo_1/tests/integration/cmd_namespace_test.go:36
...
 to contain substring
     <string>: cmd-namespace-test36csz
 In [It] at: /go/odo_1/tests/integration/cmd_namespace_test.go:38 @ 07/21/23 07:21:41.626

Unrelated issue with odo list namespace tests (already reported in #6966)

/override OpenShift-Integration-tests/OpenShift-Integration-tests

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-merge-robot openshift-merge-robot merged commit 2516489 into redhat-developer:main Jul 21, 2023
@openshift-merge-robot openshift-merge-robot temporarily deployed to internal July 21, 2023 08:39 — with GitHub Actions Inactive
@feloy feloy mentioned this pull request Jul 31, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation lgtm Indicates that a PR is ready to be merged. Required by Prow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the API Server - expose Swagger UI
3 participants