...

Text file src/github.com/twmb/franz-go/generate/NOTE

Documentation: github.com/twmb/franz-go/generate

     1When adding new commands or modifying commands,
     2
     3Metadata or ApiVersions
     4=======================
     5
     6Metadata modifications may need some new field copying in fetchMetadata.
     7
     8ApiVersions is slightly special cased in shardedRequest, and thus may need some
     9modifying as well (but this is unlikely).
    10
    11Admin Requests
    12===============
    13
    14Audit if the parseErr in handleAdminReq needs to be modified.
    15
    16
    17Group / Txn Requests
    18====================
    19
    20If the request is shardable, continue below.
    21
    22Otherwise, audit if the parseErr in handleCoordinatorReq needs to be modified.
    23
    24Shardable Requests
    25==================
    26
    27If the request is an existing request, audit if any struct copying portion
    28needs to have new fields copied. This is especially relevant while sharding and
    29merging.
    30
    31As well, audit if any onResp needs to do any additional cleanup.
    32
    33Current shardable requests:
    34 - *kmsg.ListOffsetsRequest,             // key 2
    35 - *kmsg.DescribeGroupsRequest,          // key 15
    36 - *kmsg.ListGroupsRequest,              // key 16
    37 - *kmsg.DeleteRecordsRequest,           // key 21
    38 - *kmsg.OffsetForLeaderEpochRequest,    // key 23
    39 - *kmsg.DescribeConfigsRequest,         // key 32
    40 - *kmsg.AlterConfigsRequest,            // key 33
    41 - *kmsg.AlterReplicaLogDirsRequest,     // key 34
    42 - *kmsg.DescribeLogDirsRequest,         // key 35
    43 - *kmsg.DeleteGroupsRequest,            // key 42
    44 - *kmsg.IncrementalAlterConfigsRequest: // key 44

View as plain text