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

docs: fix timeouts in the health check example and update links for config-default.yaml reference #2265

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kayx23
Copy link
Member

@kayx23 kayx23 commented Jul 23, 2024

Type of change:

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches
  • Documentation
  • Refactor
  • Chore
  • CI/CD or Tests

What this PR does / why we need it:

Encountered errors using the correct example.

Error from server (BadRequest): error when creating "upstreams.yaml": ApisixUpstream in version "v2" cannot be handled as a ApisixUpstream: strict decoding error: unknown field "spec.healthCheck.passive.unhealthy.timeout"

spec.healthCheck.active.timeout: Invalid value: "string": spec.healthCheck.active.timeout in body must be of type number: "string"

This PR fixes the example.

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@kayx23 kayx23 requested a review from pottekkat July 23, 2024 09:23
Copy link
Contributor

@pottekkat pottekkat left a comment

Choose a reason for hiding this comment

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

Could you check the lint error for the broken link?

It seems like the config-default.yaml file was moved to https://github.com/apache/apisix/blob/master/conf/config.yaml.example and now we define the default config in a Lua file: apache/apisix#11343

It should be a find and replace fix and since the scope of this PR isn't too big, we can fix it here itself.

@kayx23 kayx23 changed the title docs: fix timeouts in the health check example docs: fix timeouts in the health check example and update links for config-default.yaml reference Jul 23, 2024
Copy link

This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 30 days if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the [email protected] list. Thank you for your contributions.

@github-actions github-actions bot added the stale label Sep 22, 2024
@kayx23 kayx23 removed the stale label Sep 22, 2024
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.

2 participants