Sean Policarpio created KAFKA-6962:
--------------------------------------
Summary: DescribeConfigsRequest Schema documentation is
wrong/missing detail
Key: KAFKA-6962
URL: https://issues.apache.org/jira/browse/KAFKA-6962
Project: Kafka
Issue Type: Improvement
Components: core
Affects Versions: 1.1.0
Reporter: Sean Policarpio
The Resource fields for DescribeConfigsRequest for the following fields are all
{{null}}:
* resource_type
* resource_name
* config_names
Additionally, after using the API, I've also noted that {{resource_name}}
should probably be listed as a nullable String since it's optional.
The PR attached would output something like the following:
*Requests:*
{{DescribeConfigs Request (Version: 0) => [resources] }}
{{ resources => resource_type resource_name [config_names] }}
{{ resource_type => INT8}}
{{ resource_name => NULLABLE_STRING}}
{{ config_names => STRING}}
||Field||Description||
|resources|An array of config resources to be returned.|
|resource_type|The resource type, which is one of 0 (UNKNOWN), 1 (ANY), 2
(TOPIC), 3 (GROUP), 4 (BROKER)|
|resource_name|The resource name to query. If set to null, will retrieve all
resources of type resource_type|
|config_names|An array of config names to retrieve. If set to null, then all
configs are returned|
{{DescribeConfigs Request (Version: 1) => [resources] include_synonyms }}
{{ resources => resource_type resource_name [config_names] }}
{{ resource_type => INT8}}
{{ resource_name => NULLABLE_STRING}}
{{ config_names => STRING}}
{{ include_synonyms => BOOLEAN}}
||Field||Description||
|resources|An array of config resources to be returned.|
|resource_type|The resource type, which is one of 0 (UNKNOWN), 1 (ANY), 2
(TOPIC), 3 (GROUP), 4 (BROKER)|
|resource_name|The resource name to query. If set to null, will retrieve all
resources of type resource_type|
|config_names|An array of config names to retrieve. If set to null, then all
configs are returned|
|include_synonyms|null|
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
