[Bug]: content-length-guardrail policy schema accepts a configuration with neither request nor response
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 83/100
Research direction
Locate the content-length-guardrail policy's policy-definition.yaml and compare its schema with the word-count-guardrail, sentence-count-guardrail, regex-guardrail, and url-guardrail schemas. Add the request-or-response requirement described in the issue, then confirm the schema rejects empty params while accepting a configuration with either request or response. The issue also points to the integration assertion in wso2/gateway-controllers#415.
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/API (API backends, definitions, contracts, interfaces, OpenAPI), Aspect/Configuration (Config files, settings, env vars, defaults)
Description
The content-length-guardrail documentation says: "At least one of request or response must be provided." The policy refuses a configuration with neither. Its schema does not enforce the rule, so such a configuration passes API creation and fails at runtime instead.
The API is created, and every request to the operation then gets HTTP 500. A mistake that should fail the deployment breaks the operation.
Other guardrails in the repository enforce this rule in their schema, for example word-count-guardrail, sentence-count-guardrail, regex-guardrail and url-guardrail:
anyOf:
- required: [ request ]
- required: [ response ]
A fix could add the same rule to the policy's policy-definition.yaml.
The integration suite in wso2/gateway-controllers#415 asserts this behaviour.
Steps to Reproduce
- Create a REST API with an operation that attaches the policy with empty parameters:
{"name":"content-length-guardrail","version":"v1","params":{}} - The API is created.
- Every request to that operation gets HTTP 500. An operation on the same API with a valid configuration still works.
Severity Level of the Issue
Severity/Minor (Non-critical functionality. Can be fixed in future releases)
Environment Details (with versions)
- Policy:
content-length-guardrailv1.1.0, wso2/gateway-controllers main (4f1520a8) - Gateway versions: 1.1.0 (patched), 1.2.0 and latest (
main-59dcd51)
- 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
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsOpenArea/Policies Aspect/Other Severity/Trivial Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 91/100
wso2/api-platform#4355 ·
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
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