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 Swagger UI Catalog example error #578

Merged
merged 1 commit into from
Jul 25, 2022

Conversation

QuanZhang-William
Copy link
Member

@QuanZhang-William QuanZhang-William commented Jul 19, 2022

Prior to this commit, "tektoncd" is used as a showcase example in goa-gen design. This is reflected as default example in the "resouce" section of Swagger UI, which results in 404 issue when trying out the examples with default values. This commit fixes the issue by correcting the default catalog values from "tektoncd" to "tekton"

179621495-9c00333e-2709-4777-9bff-b7f83a8afa9b

179621471-07f41fff-d8da-401d-8f75-0f4b4d8b5d49

Changes

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Run API Unit Tests, Lint Checks, API Design, Golden Files with make api-check
  • Run UI Unit Tests, Lint Checks with make ui-check
  • Commit messages follow commit message best practices

See the contribution guide for more details.

Prior to this commit, "tektoncd" is used as catalog example in the "resouce" section of Swagger UI, which results in 404 issue when trying out the example. This commit fixes the issue by correcting "tektoncd" to "tekton"
@tekton-robot
Copy link

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@tekton-robot tekton-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 19, 2022
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 19, 2022
@QuanZhang-William
Copy link
Member Author

/test all

@QuanZhang-William QuanZhang-William changed the title Fix Swagger UI Catalog example typo Fix Swagger UI Catalog example error Jul 19, 2022
@vinamra28
Copy link
Member

/retest

1 similar comment
@piyush-garg
Copy link
Contributor

/retest

@QuanZhang-William QuanZhang-William marked this pull request as ready for review July 20, 2022 20:57
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 20, 2022
Copy link
Member

@vinamra28 vinamra28 left a comment

Choose a reason for hiding this comment

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

@tekton-robot
Copy link

@vinamra28: cat image

In response to this:

/meow
/cc @piyush-garg @PuneetPunamiya

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.

@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vinamra28

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

The pull request process is described 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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 24, 2022
@PuneetPunamiya
Copy link
Member

Thanks for the pr, the patch looks fine but I have a small concern about this because we are adding these examples in goa design to showcase user what all values can be added, but for the beginners it might be confusing as well

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 25, 2022
@vinamra28
Copy link
Member

/retest

@tekton-robot tekton-robot merged commit 0a38d40 into tektoncd:main Jul 25, 2022
@QuanZhang-William
Copy link
Member Author

@PuneetPunamiya I have updated the PR description and added some screenshots to show the issue better. Hope this is clearer to beginners like me 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants