Skip to content

[Docs] Fix malformed Consul API link in client documentation - #3624

Merged
chenBright merged 1 commit into
apache:masterfrom
NUAAwqy:taiyi/fix-consul-doc-link-20261018
Oct 19, 2026
Merged

chenBright merged 1 commit into
apache:masterfrom
NUAAwqy:taiyi/fix-consul-doc-link-20261018

Conversation

@NUAAwqy

@NUAAwqy NUAAwqy commented Oct 18, 2026

Copy link
Copy Markdown
Contributor

What problem does this PR solve?

Issue Number: resolves #3623

Problem Summary:

docs/en/client.md has two opening parentheses before the Consul health API URL. Markdown parsers therefore capture a URL beginning with ( instead of a valid HTTPS URL.

What is changed and the side effects?

Changed:

  • Remove the extra opening parenthesis from the Consul request-parameters link.

Side effects:

  • Documentation-only; no runtime or API behavior changes.
  • Performance effects: None.
  • Breaking backward compatibility: None.

Check List:

  • Confirmed the original parser reproduction captured '(https://www.consul.io/api/health.html#parameters-2' with an empty scheme and netloc.
  • Confirmed the fixed text captures https://www.consul.io/api/health.html#parameters-2 with scheme https and netloc www.consul.io.
  • git diff --check passes.
  • Only docs/en/client.md is changed.

Codex assistance was used to investigate, reproduce, and prepare this documentation fix; the change and validation evidence were reviewed against the upstream source.

@chenBright chenBright left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@chenBright
chenBright merged commit f0239d7 into apache:master Oct 19, 2026
1 check passed
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.

Fix malformed Consul API link in English client documentation

2 participants