Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fix typos and correct copy/past mistakes

...

Code Block
languagediff
{  
  "apiKey": 9,  
  "type": "request",  
  "listeners": ["zkBroker", "broker"],  
  "name": "OffsetFetchRequest",  
  "validVersions": "0-<next-version>",  
  "deprecatedVersions": "0",  
  "flexibleVersions": "6+",  
  "fields": [  
    { "name": "GroupId", "type": "string", "versions": "0-7", "entityType": "groupId", "about": "The group to fetch offsets for." },  
    { "name": "Topics", "type": "[]OffsetFetchRequestTopic", "versions": "0-7", "nullableVersions": "2-7", "fields": [ ... ]},  
    { "name": "Groups", "type": "[]OffsetFetchRequestGroup", "versions": "8+", "about": "Each group we would like to fetch offsets for", "fields": [ ... ]},  
    { "name": "RequireStable", "type": "bool", "versions": "7+", "default": "false"},  
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000", "about": "The maximum number of partitions included in the response." },  
+   { "name": "Cursor", "ignorable": true, "type": "OffsetFetchCursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null", "about": "The first topic and partition index to fetch details for.", "fields": [ 
+     { "name": "GroupId", "type": "string", "versions": "<next-version>+", "about": "The group ID to start with"}  
+     { "name": "TopicName", "type": "string", "versions": "<next-version>+", 
+        "about": "The name for the first topic for given group id to process", "entityType": "topicName"},  
+     { "name": "PartitionIndex", "type": "int32", "versions": "<next-version>+", "about": "The partition index to start with"}  
+  ]}  
  ]  
}

...

Code Block
languagediff
{  
  "apiKey": 35,  
  "type": "request",  
  "listeners": ["zkBroker", "broker"],  
  "name": "DescribeLogDirsRequest",  
  "validVersions": "0-<next-version>",  
  "deprecatedVersions": "0",  
  "flexibleVersions": "2+",  
  "fields": [  
    { "name": "Topics", "type": "[]DescribableLogDirTopic", "versions": "0+", "nullableVersions": "0+", "about": "Each topic that we want to describe log directories for, or null for all topics.", "fields": [ ... ]},  
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of partitions included in the response." },  
+   { "name": "Cursor", "ignorable": true, "type": "Cursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null",  
+     "about": "The first topic, partition index and logDir to fetch details for.", "fields": [  
+     { "name": "TopicName", "type": "string", "versions": "<next-version>+",  
+.        "about": "The name for the first topic to process", "entityType": "topicName"},  
+     { "name": "PartitionIndex", "type": "int32", "versions": "<next-version>+", "about": "The partition index to start with"},
+     { "name: "LogDir", "type": "string", "versions": "<next-version>+", "about": "The absolute log directory path for the topic partition to start with."}
+  ]}  
  ]  
}

...

Code Block
languagediff
{
  "apiKey": 46,
  "type": "request",
  "listeners": ["broker", "controller", "zkBroker"],
  "name": "ListPartitionReassignmentsRequest",
  "validVersions": "0-<next-version>",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "TimeoutMs", "type": "int32", "versions": "0+", "default": "60000", "about": "The time in ms to wait for the request to complete." },
    { "name": "Topics", "type": "[]ListPartitionReassignmentsTopics", "versions": "0+", "nullableVersions": "0+", "default": "null",
      "about": "The topics to list partition reassignments for, or null to list everything.", "fields": [ ... ]},
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of partitions included in the response." },  
+   { "name": "Cursor", "ignorable": true, "type": "Cursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null",  
+     "about": "The first topic and partition index to fetch details for.", "fields": [  
+     { "name": "TopicName", "type": "string", "versions": "<next-version>+",  "about": "The name for the first topic to process", "entityType": "topicName"},  
+     { "name": "PartitionIndex", "type": "int32", "versions": "<next-version>+", "about": "The partition index to start with"}  
+  ]}  
  ]
}

...

Code Block
languagediff
{
  "apiKey": 2,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "ListOffsetsRequest",
  "validVersions": "0-<next-version>",
  "deprecatedVersions": "0",
  "flexibleVersions": "6+",
  "latestVersionUnstable": true,
  "fields": [
    { "name": "ReplicaId", "type": "int32", "versions": "0+", "entityType": "brokerId" },
    { "name": "IsolationLevel", "type": "int8", "versions": "2+" },
    { "name": "Topics", "type": "[]ListOffsetsTopic", "versions": "0+", "about": "Each topic in the request.", "fields": [ ... ]},
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of partitions included in the response." },  
+   { "name": "Cursor", "ignorable": true, "type": "Cursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null",  
+     "about": "The first topic and partition index to fetch details for.", "fields": [  
+     { "name": "TopicName", "type": "string", "versions": "<next-version>+",  "about": "The name for the first topic to process", "entityType": "topicName"},  
+     { "name": "PartitionIndex", "type": "int32", "versions": "<next-version>+", "about": "The partition index to start with"}  
+  ]}  
  ]
}

...

Code Block
languagediff
{
  "apiKey": 2,
  "type": "response",
  "name": "ListOffsetsResponse",
  "validVersions": "0-<next-version>",
  "flexibleVersions": "6+",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "2+", "ignorable": true },
    { "name": "Topics", "type": "[]ListOffsetsTopicResponse", "versions": "0+", "about": "Each topic in the response.", "fields": [...]},
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of partitions included in the response." },  
+   { "name": "NextCursor", "ignorable": true, "type": "Cursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null",  
+     "about": "The first topic and partition index to fetch details for.", "fields": [  
+     { "name": "TopicName", "type": "string", "versions": "<next-version>+",  "about": "The name for the first topic to process", "entityType": "topicName"},  
+     { "name": "PartitionIndex", "type": "int32", "versions": "<next-version>+", "about": "The partition index to start with"},
+  ]}   
  ]
}

...

Code Block
languagediff
{
  "apiKey": 3,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "MetadataRequest",
  "validVersions": "0-<next-version>",
  "deprecatedVersions": "0-3",
  "flexibleVersions": "9+",
  "fields": [
    { "name": "Topics", "type": "[]MetadataRequestTopic", "versions": "0+", "nullableVersions": "1+",
      "about": "The topics to fetch metadata for.", "fields": [
      { "name": "TopicId", "type": "uuid", "versions": "10+", "ignorable": true, "about": "The topic id." },
      { "name": "Name", "type": "string", "versions": "0+", "entityType": "topicName", "nullableVersions": "10+",
        "about": "The topic name." }
    ]},
    ...
 +   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000", "about": "The maximum number of partitions included in the response." },  
+   { "name": "Cursor", "ignorable": true, "type": "OffsetFetchCursorCursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null", "about": "The first topic and partition index to fetch details for.", "fields": [ 
+     { "name": "GroupId", "type": "string", "versions": "<next-version>+", "about": "The group ID to start with"}  
+     { "name": "TopicName", "type": "string", "versions": "<next-version>+", "about": "The name for the first topic to process", "entityType": "topicName"},  
+     { "name": "PartitionIndex", "type": "int32", "versions": "<next-version>+", "about": "The partition index to start with"}  
+  ]}  
  ]
}

...

Code Block
languagediff
{  
  "apiKey": 61,  
  "type": "request",  
  "listeners": ["zkBroker", "broker"],  
  "name": "DescribeProducersRequest",  
  "validVersions": "0-<next-version>",  
  "flexibleVersions": "0+",  
  "fields": [  
    { "name": "Topics", "type": "[]TopicRequest", "versions": "0+", "fields": [ ... ]},  
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of producer id included in the response." },  
+   { "name": "Cursor", "ignorable": true, "type": "ProducerStateCursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null",  
+     "about": "The first PID, topic and partition index to fetch details for.", "fields": [  
+     { "name": "TopicName", "type": "string", "versions": "<next-version>+", "about": "The name for the first topic to process", "entityType": "topicName"},  
+     { "name": "PartitionIndex", "type": "int32", "versions": "<next-version>+", "about": "The partition index to start with"},  
+     { "name": "ProducerId", "type": "int64", "versions": "<next-version>+", "about": "The producer id to start with"}
+   ]}
  ]  
}

...

Code Block
languagediff
{  
  "apiKey": 66,  
  "type": "request",  
  "listeners": ["zkBroker", "broker"],  
  "name": "ListTransactionsRequest",  
  "validVersions": "0-<next-version>",  
  "flexibleVersions": "0+",  
  "fields": [  
    { "name": "StateFilters", "type": "[]string", "versions": "0+" },  
    { "name": "ProducerIdFilters", "type": "[]int64", "versions": "0+", "entityType": "producerId"},  
    { "name": "DurationFilter", "type": "int64", "versions": "1+", "default": -1},  
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of transactions included in the response." },
+   { "name": "Cursor", "ignorable": true, "type": "TransactionalCursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null",  
+     "about": "The first transaction id and producer id to fetch details for.", "fields": [  
+     { "name": "TransactionalId", "type": "string", "versions": "<next-version>+", "about": "The id for the first transaction to process"},  
+     { "name": "ProducerId", "type": "string", "versions": "<next-version>+", "about": "The id for the first transaction to process"}  
+  ]}  
 ]  
}

...

Code Block
languagediff
{
  "apiKey": 65,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "DescribeTransactionsRequest",
  "validVersions": "0-<next-version>",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "TransactionalIds", "entityType": "transactionalId", "type": "[]string", "versions": "0+" }
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of transactions included in the response." },
+   { "name": "Cursor", "ignorable": true, "type": "TransactionalCursor", "versions": "<next-version>+", "nullableVersions": "<next-version>+", "default": "null",  
+     "about": "The first transaction id and producer id to fetch details for.", "fields": [  
+     { "name": "TransactionalId", "type": "string", "versions": "<next-version>+", "about": "The id for the first transaction to process"},  
+     { "name": "ProducerId", "type": "string", "versions": "<next-version>+", "about": "The id for the first transaction to process"},
+  ]}   
  ]
}

...

Code Block
languagediff
{
  "apiKey": 16,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "ListGroupsRequest",
  "validVersions": "0-<next-version>",
  "flexibleVersions": "3+",
  "fields": [
    { "name": "StatesFilter", "type": "[]string", "versions": "4+",
      "about": "The states of the groups we want to list. If empty, all groups are returned with their state." },
    { "name": "TypesFilter", "type": "[]string", "versions": "5+",
      "about": "The types of the groups we want to list. If empty, all groups are returned with their type." },
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of group id included in the response." },  
+   { "name": "Cursor", "type": "GroupCursor", "versions": "<next-version>+", "nullableVersions": "0+", "default": "null",
+      "about": "The group id index to fetch details for.", "fields": [
+      { "name": "GroupId", "type": "string", "versions": "<next-version>+", "about": "The group id for the first group to process"}
+    ]}
  ]
}

...

Code Block
languagediff
{
  "apiKey": 15,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "DescribeGroupsRequest",
  "validVersions": "0-<next-version>",
  "flexibleVersions": "5+",
  "fields": [
    { "name": "Groups", "type": "[]string", "versions": "0+", "entityType": "groupId", "about": "The names of the groups to describe" },
    { "name": "IncludeAuthorizedOperations", "type": "bool", "versions": "3+", "about": "Whether to include authorized operations." },
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of members of group included in the response." },  
+   { "name": "Cursor", "type": "GroupMemeberCursor", "versions": "<next-version>+", "nullableVersions": "0+", "default": "null",
+      "about": "The first member and group id index to fetch details for.", "fields": [
+      { "name": "GroupId", "type": "string", "versions": "<next-version>+", "about": "The group id for the first group to process"},
+      { "name": "MemberId", "type": "string", "versions": "<next-version>+", "about": "The member id for the first group to process"}
+   ]}
  ]
}

...

Code Block
languagediff
{
  "apiKey": 69,
  "type": "request",
  "listeners": ["zkBroker", "broker"],
  "name": "ConsumerGroupDescribeRequest",
  "validVersions": "0-<next-version>",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "GroupIds", "type": "[]string", "versions": "0+", "entityType": "groupId", "about": "The ids of the groups to describe" },
    { "name": "IncludeAuthorizedOperations", "type": "bool", "versions": "0+", "about": "Whether to include authorized operations." },
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of members of group included in the response." },  
+   { "name": "Cursor", "type": "GroupMemeberCursor", "versions": "<next-version>+", "nullableVersions": "0+", "default": "null",
+      "about": "The first member and group id index to fetch details for.", "fields": [
+      { "name": "GroupId", "type": "string", "versions": "<next-version>+", "about": "The group id for the first group to process"},
+      { "name": "MemberId", "type": "string", "versions": "<next-version>+", "about": "The member id for the first group to process"}
+   ]}
  ]
}

...

Code Block
languagediff
{
  "apiKey": 29,
  "type": "request",
  "listeners": ["zkBroker", "broker", "controller"],
  "name": "DescribeAclsRequest",
  "validVersions": "0-<next-version>",
  "deprecatedVersions": "0",
  "flexibleVersions": "2+",
  "fields": [
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of resources included in the response." },
+   { "name": "Cursor", "type": "ResourceCursor", "versions": "<next-version>+", "nullableVersions": "0+", "default": "null",
+      "about": "The first acl index to fetch details for.", "fields": [
+      { "name": "ResourceName", "type": "string", "versions": "<next-version>+", "about": "The resource name for the first resource to process"},
+      { "name": "Resourcetype", "type": "string", "versions": "<next-version>+", "about": "The resource type for the first resource to process"}
+   ]}
  ]
}

...

Code Block
languagediff
{
  "apiKey": 32,
  "type": "request",
  "listeners": ["zkBroker", "broker", "controller"],
  "name": "DescribeConfigsRequest",
  "validVersions": "0-<next-version",
  "deprecatedVersions": "0",
  "flexibleVersions": "4+",
  "fields": [
    { "name": "Resources", "type": "[]DescribeConfigsResource", "versions": "0+", "fields": [
      { "name": "ResourceType", "type": "int8", "versions": "0+", "about": "The resource type." },
      { "name": "ResourceName", "type": "string", "versions": "0+", "about": "The resource name." },
      { "name": "ConfigurationKeys", "type": "[]string", "versions": "0+", "nullableVersions": "0+"}
    ]},
    { "name": "IncludeSynonyms", "type": "bool", "versions": "1+", "default": "false", "ignorable": false},
    { "name": "IncludeDocumentation", "type": "bool", "versions": "3+", "default": "false", "ignorable": false},
+   { "name": "ResponsePagingationLimitResponsePaginationLimit", "ignorable": true, "type": "int32", "versions": "<next-version>+", "default": "2000",  
+     "about": "The maximum number of resources included in the response." },
+   { "name": "Cursor", "type": "ResourceCursor", "versions": "<next-version>+", "nullableVersions": "0+", "default": "null",
+      "about": "The first acl index to fetch details for.", "fields": [
+      { "name": "ResourceName", "type": "string", "versions": "<next-version>+", "about": "The resource name for the first resource to process"},
+      { "name": "Resourcetype", "type": "string", "versions": "<next-version>+", "about": "The resource type for the first resource to process"}
+   ]}
  ]
}

...