// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements.  See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License.  You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

{
  "apiKey": 54,
  "type": "request",
  "listeners": ["controller"],
  "name": "EndQuorumEpochRequest",
  // Version 1 adds flexible versions, replaces preferred successors with preferred candidates
  // and adds leader endpoints (KIP-853)
  "validVersions": "0-1",
  "flexibleVersions": "1+",
  "fields": [
    { "name": "ClusterId", "type": "string", "versions": "0+",
      "nullableVersions": "0+", "default": "null",
      "about": "The cluster id."},
    { "name": "Topics", "type": "[]TopicData", "versions": "0+",
      "about": "The topics.", "fields": [
        { "name": "TopicName", "type": "string", "versions": "0+", "entityType": "topicName",
          "about": "The topic name." },
        { "name": "Partitions", "type": "[]PartitionData", "versions": "0+",
          "about": "The partitions.", "fields": [
            { "name": "PartitionIndex", "type": "int32", "versions": "0+",
              "about": "The partition index." },
            { "name": "LeaderId", "type": "int32", "versions": "0+", "entityType": "brokerId",
              "about": "The current leader ID that is resigning."},
            { "name": "LeaderEpoch", "type": "int32", "versions": "0+",
              "about": "The current epoch."},
            { "name": "PreferredSuccessors", "type": "[]int32", "versions": "0", "ignorable": true,
              "about": "A sorted list of preferred successors to start the election." },
            { "name": "PreferredCandidates", "type": "[]ReplicaInfo", "versions": "1+", "ignorable": true,
              "about": "A sorted list of preferred candidates to start the election.", "fields": [
                { "name": "CandidateId", "type": "int32", "versions": "1+", "entityType": "brokerId",
                  "about": "The ID of the candidate replica."},
                { "name": "CandidateDirectoryId", "type": "uuid", "versions": "1+",
                  "about": "The directory ID of the candidate replica."}
              ]
            }
          ]
        }
      ]
    },
    { "name": "LeaderEndpoints", "type": "[]LeaderEndpoint", "versions": "1+", "ignorable": true,
      "about": "Endpoints for the leader.", "fields": [
        { "name": "Name", "type": "string", "versions": "1+", "mapKey": true, "about": "The name of the endpoint." },
        { "name": "Host", "type": "string", "versions": "1+", "about": "The node's hostname." },
        { "name": "Port", "type": "uint16", "versions": "1+", "about": "The node's port." }
      ]
    }
  ]
}
