You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/06/20 04:03:57 UTC
[GitHub] [pulsar] poorbarcode opened a new issue, #16135: [PIP-178] Support admin API fail on unknown request parameter
poorbarcode opened a new issue, #16135:
URL: https://github.com/apache/pulsar/issues/16135
### Motivation
The design of the Admin API is now such that if an incorrect parameter name is submitted, this property (if not required) will be ignored, then execution continues, and the response is “204 Success”. This will trick the user into thinking the setup succeeded when it didn't correctly as expected in some cases, as shown below:
User POST request to /{tenant}/{namespace}/{topic}/retention" with incorrect parameter:
```json
{"retention_size_in_mb":-1,"retention_time_in_minutes":40320}
```
Which should have been this:
```json
{"retentionSizeInMB":-1,"retentionTimeInMinutes":40320}
```
Response:
```http
HTTP/1.1 204 No Content
Date: Mon, 20 Jun 2022 02:54:25 GMT
broker-address: 127.0.0.1
Server: Jetty(9.4.44.v20210927)
```
We can provide an optional mechanism: "fail (http status 400 bad request) on unknown request parameters".
## Goal
- scope:
- ~~Path variables~~: This represents the domain. The current API has been validated, so no additional modifications are required.
- ~~Query params~~: I haven't found an elegant way to do it yet, so this Propasal does not include Query Param validation.
- *Entity properties*: This proposal only handles requests whose Content-type is "application/json" (in fact, this is the only type in our project).
- Configurable(no dynamic), minimum configuration granularity is the admin version(v1, v2, v3)
## Approach
When parsing the request body, any unknown property is considered an bad request. The [Jackson unkown property rule](https://github.com/FasterXML/jackson-databind/blob/de3d0ecbc1fd0a1a6b061e62a198b3ba0d0d163e/src/main/java/com/fasterxml/jackson/databind/DeserializationFeature.java#L121) is adopted:
- Case sensitive.
- Special characters are not ignored.
- Do not trim Spaces.
If the check fails, return a text/plain response with 400 code. Like this:
```http
HTTP/1.1 400 Bad Request
Date: Mon, 20 Jun 2022 03:52:10 GMT
broker-address: 127.0.0.1
Content-Type: text/plain
Content-Length: 432
Server: Jetty(9.4.44.v20210927)
Unrecognized field "retention_size_in_mb" (class org.apache.pulsar.common.policies.data.RetentionPolicies known properties: "retentionSizeInMB", "retentionTimeInMinutes"])
```
## Configuration Changes
broker.conf
```properties
# Admin API fail on unknown request parameter in request-body. see PIP-178. Setting this to blank means that this feature is turned off.
adminApiFailOnUnknownProperties=v1,v2,v3
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Jason918 commented on issue #16135: [PIP-178] Support the admin API to check unknown request parameters
Posted by GitBox <gi...@apache.org>.
Jason918 commented on issue #16135:
URL: https://github.com/apache/pulsar/issues/16135#issuecomment-1161237208
PIP ID is used by #16042
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] poorbarcode commented on issue #16135: [PIP-179] Support the admin API to check unknown request parameters
Posted by GitBox <gi...@apache.org>.
poorbarcode commented on issue #16135:
URL: https://github.com/apache/pulsar/issues/16135#issuecomment-1161239127
> PIP ID is used by #16042
I have corrected it. Thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] poorbarcode commented on issue #16135: [PIP-179] Support the admin API to check unknown request parameters
Posted by GitBox <gi...@apache.org>.
poorbarcode commented on issue #16135:
URL: https://github.com/apache/pulsar/issues/16135#issuecomment-1162576804
Discuss Link: https://lists.apache.org/thread/m8vkxl46njm7sh0r1mqsn25jggq9v8kb
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] poorbarcode closed issue #16135: [PIP-179] Support the admin API to check unknown request parameters
Posted by GitBox <gi...@apache.org>.
poorbarcode closed issue #16135: [PIP-179] Support the admin API to check unknown request parameters
URL: https://github.com/apache/pulsar/issues/16135
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] poorbarcode commented on issue #16135: [PIP-179] Support the admin API to check unknown request parameters
Posted by GitBox <gi...@apache.org>.
poorbarcode commented on issue #16135:
URL: https://github.com/apache/pulsar/issues/16135#issuecomment-1197891087
complete.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org