[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy accepts
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
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.mdin 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
- Read the parameter table in
docs/host-rewrite/v1.1/docs/host-rewrite.md. - Compare it with the
patterninpolicies/host-rewrite/policy-definition.yaml. - Deploy an API with host-rewrite
host: backend.example.com:8080andhostRewrite: manualon the upstream. - 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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from wso2/api-platform
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
wso2/api-platform#4369 ·
Maintainers usually reply within 1 day
-
Area/Gateway Aspect/API Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
wso2/api-platform#4348 ·
Maintainers usually reply within 1 day
-
Aspect/AI Aspect/API. Severity/Major
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
wso2/api-platform#4343 ·
Maintainers usually reply within 1 day
-
Area/Policies Aspect/Configuration Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
wso2/api-platform#4330 ·
Maintainers usually reply within 1 day
-
Area/Policies Aspect/API Aspect/Configuration Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
wso2/api-platform#4329 ·
Maintainers usually reply within 1 day
All issues in wso2/api-platform
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
keyxmakerx/Chronicle#2285 ·
Maintainers usually reply within 1 day
-
vLLM metrics adapter tests start the adapter twice and race on its request countersPossibly taken @bhargavchintam claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
llm-d/llm-d-inference-sim#933 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
spellshift/realm#2509 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
lionsoul2014/ip2region#552 ·
Maintainers usually reply within 1 day