[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy accepts

Open Beginner friendly
#4,355 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
91/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
go
Domain
documentation

Research direction

Read docs/host-rewrite/v1.1/docs/host-rewrite.md, section "User Parameters (API Definition)", and compare its allowed-character description with the pattern in policies/host-rewrite/policy-definition.yaml. Update the documentation to include the colon already accepted by the schema. Done when the parameter table accurately describes the accepted host characters, including ports such as backend.example.com:8080.

Written by the indexing model from the issue text.

Description

Area/Policies Aspect/Other Severity/Trivial Type/Bug
Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/Other (Anything else which does not match above categories)

Description

The parameter table in the host-rewrite policy documentation says the host value allows letters, digits, - and .. The policy's schema also allows :.

  • Doc: docs/host-rewrite/v1.1/docs/host-rewrite.md in wso2/gateway-controllers, section "User Parameters (API Definition)": "Allowed characters: letters, digits, - and .."
  • Schema: policies/host-rewrite/policy-definition.yaml, pattern: "^[a-zA-Z0-9.:-]+$".

The doc's own Notes section says a port may be included, for example backend.example.com:8080. That needs :. The integration tests confirm a host with a port is accepted and sent upstream unchanged.

Steps to Reproduce
  1. Read the parameter table in docs/host-rewrite/v1.1/docs/host-rewrite.md.
  2. Compare it with the pattern in policies/host-rewrite/policy-definition.yaml.
  3. Deploy an API with host-rewrite host: backend.example.com:8080 and hostRewrite: manual on the upstream.
  4. The API is accepted, and the upstream receives Host: backend.example.com:8080.
Severity Level of the Issue

Severity/Trivial (Cosmetic issues. Can be fixed in future releases)

Environment Details (with versions)
  • host-rewrite policy v1.1.0, built from wso2/gateway-controllers source (commit 4f1520a8). Doc v1.1.
  • Gateway 1.1.0, 1.2.0 and main (main-a7e8774).
Dominant language
Go
Stars
85
Forks
137
Avg merge
1d 12h
Merged PRs (30d)
247

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wso2/api-platform

All issues in wso2/api-platform

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.