Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-9643

AlterConfigsRequest and IncrementalAlterConfigsRequest use conflicting type names

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • 2.4.0
    • None
    • protocol

    Description

      In general the message format definitions used by the generator have maintained unique types between them.

      However, the AlterConfigsRequest and IncrementalAlterConfigsRequest definitions both refer to the AlterConfigsResource and AlterableConfig type, with the latter containing different fields in the Incremental case

      https://github.com/apache/kafka/blob/69b670a444c7638f663e13dc37e0532ce64b1363/clients/src/main/resources/common/message/AlterConfigsRequest.json#L23-L36

      https://github.com/apache/kafka/blob/69b670a444c7638f663e13dc37e0532ce64b1363/clients/src/main/resources/common/message/IncrementalAlterConfigsRequest.json#L23-L38

      In the response case, the whole format is currently identical (although that may change in the future) and both refer to an "AlterConfigsResponse" type with identical fields

      https://github.com/apache/kafka/blob/69b670a444c7638f663e13dc37e0532ce64b1363/clients/src/main/resources/common/message/AlterConfigsResponse.json#L23-L38

      https://github.com/apache/kafka/blob/69b670a444c7638f663e13dc37e0532ce64b1363/clients/src/main/resources/common/message/IncrementalAlterConfigsResponse.json#L23-L38

      I'm not sure what any potential backward compatibility ramifications would be, but it seems like it would be a good idea to avoid this collision by (e.g.,) prefixing the Incremental types with "Incremental" going forward.

       

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            dnwe Dominic Evans
            Colin McCabe Colin McCabe
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: