Skip to content

Commit 966dc8d

Browse files
committed
fix: update CreateTopics API stage descriptions to use version 6
Update all stage descriptions for the CreateTopics API to reference version 6 instead of version 7. This includes adjustments to the interactive protocol inspector links and the testing procedures to ensure consistency across all stages. The changes clarify the expected request and response structures for the API.
1 parent b65a370 commit 966dc8d

File tree

8 files changed

+25
-25
lines changed

8 files changed

+25
-25
lines changed

stage_descriptions/create-topics-01_yb1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ The [CreateTopics API](https://kafka.apache.org/protocol#The_Messages_CreateTopi
66

77
We've created an interactive protocol inspector for the request & response structures for `CreateTopics`:
88

9-
- 🔎 [CreateTopics Request (v7)](https://binspec.org/kafka-createtopics-request-v7)
10-
- 🔎 [CreateTopics Response (v7)](https://binspec.org/kafka-createtopics-response-v7)
9+
- 🔎 [CreateTopics Request (v6)](https://binspec.org/kafka-createtopics-request-v6)
10+
- 🔎 [CreateTopics Response (v6)](https://binspec.org/kafka-createtopics-response-v6)
1111

1212
In this stage, you'll only need to add an entry for the `CreateTopics` API to the APIVersions response you implemented in earlier stages. This will let the client know that the broker supports the `CreateTopics` API. We'll get to responding to `CreateTopics` requests in later stages.
1313

stage_descriptions/create-topics-02_ve7.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ If the topic name is invalid, the broker returns an error code of `17` (INVALID_
1414

1515
We've created an interactive protocol inspector for the request & response structures for `CreateTopics`:
1616

17-
- 🔎 [CreateTopics Request (v7)](https://binspec.org/kafka-createtopics-request-v7)
18-
- 🔎 [CreateTopics Response (v7)](https://binspec.org/kafka-createtopics-response-v7)
17+
- 🔎 [CreateTopics Request (v6)](https://binspec.org/kafka-createtopics-request-v6)
18+
- 🔎 [CreateTopics Response (v6)](https://binspec.org/kafka-createtopics-response-v6)
1919

2020
In this stage, you'll need to implement basic topic name validation without needing to check against existing topics or system topics. You can hard code the error response for invalid topic names in this stage.
2121

@@ -27,7 +27,7 @@ The tester will execute your program like this:
2727
./your_program.sh
2828
```
2929

30-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request with an invalid topic name.
30+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request with an invalid topic name.
3131

3232
The tester will validate that:
3333

stage_descriptions/create-topics-03_cb8.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ If the topic name is reserved, the broker returns an error code of `42` (INVALID
1414

1515
We've created an interactive protocol inspector for the request & response structures for `CreateTopics`:
1616

17-
- 🔎 [CreateTopics Request (v7)](https://binspec.org/kafka-createtopics-request-v7)
18-
- 🔎 [CreateTopics Response (v7)](https://binspec.org/kafka-createtopics-response-v7)
17+
- 🔎 [CreateTopics Request (v6)](https://binspec.org/kafka-createtopics-request-v6)
18+
- 🔎 [CreateTopics Response (v6)](https://binspec.org/kafka-createtopics-response-v6)
1919

2020
We've also created an interactive protocol inspector for the `__cluster_metadata` topic's log file:
2121
- 🔎 [__cluster_metadata topic's log file](https://binspec.org/kafka-cluster-metadata)
@@ -30,7 +30,7 @@ The tester will execute your program like this:
3030
./your_program.sh
3131
```
3232

33-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request with a reserved topic name.
33+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request with a reserved topic name.
3434

3535
The tester will validate that:
3636

stage_descriptions/create-topics-04_us2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ If the topic already exists, the broker returns an error code of `36` (TOPIC_ALR
1010

1111
We've created an interactive protocol inspector for the request & response structures for `CreateTopics`:
1212

13-
- 🔎 [CreateTopics Request (v7)](https://binspec.org/kafka-createtopics-request-v7)
14-
- 🔎 [CreateTopics Response (v7)](https://binspec.org/kafka-createtopics-response-v7)
13+
- 🔎 [CreateTopics Request (v6)](https://binspec.org/kafka-createtopics-request-v6)
14+
- 🔎 [CreateTopics Response (v6)](https://binspec.org/kafka-createtopics-response-v6)
1515

1616
We've also created an interactive protocol inspector for the `__cluster_metadata` topic's log file:
1717
- 🔎 [__cluster_metadata topic's log file](https://binspec.org/kafka-cluster-metadata)
@@ -30,7 +30,7 @@ The tester will execute your program like this:
3030
# Then try to create the same topic again
3131
```
3232

33-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request for an existing topic.
33+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request for an existing topic.
3434

3535
The tester will validate that:
3636

stage_descriptions/create-topics-05_hh9.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ The response should be identical to what would be returned for actual topic crea
1717

1818
We've created an interactive protocol inspector for the request & response structures for `CreateTopics`:
1919

20-
- 🔎 [CreateTopics Request (v7)](https://binspec.org/kafka-createtopics-request-v7)
21-
- 🔎 [CreateTopics Response (v7)](https://binspec.org/kafka-createtopics-response-v7)
20+
- 🔎 [CreateTopics Request (v6)](https://binspec.org/kafka-createtopics-request-v6)
21+
- 🔎 [CreateTopics Response (v6)](https://binspec.org/kafka-createtopics-response-v6)
2222

2323
In this stage, you'll need to check the `validate_only` flag in the request and modify your behavior accordingly.
2424

@@ -30,7 +30,7 @@ The tester will execute your program like this:
3030
./your_program.sh
3131
```
3232

33-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request with `validate_only` set to `true`.
33+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request with `validate_only` set to `true`.
3434

3535
The tester will validate that:
3636

stage_descriptions/create-topics-06_fl3.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Mixed success/failure scenarios are handled gracefully - if one topic fails vali
1717

1818
We've created an interactive protocol inspector for the request & response structures for `CreateTopics`:
1919

20-
- 🔎 [CreateTopics Request (v7)](https://binspec.org/kafka-createtopics-request-v7)
21-
- 🔎 [CreateTopics Response (v7)](https://binspec.org/kafka-createtopics-response-v7)
20+
- 🔎 [CreateTopics Request (v6)](https://binspec.org/kafka-createtopics-request-v6)
21+
- 🔎 [CreateTopics Response (v6)](https://binspec.org/kafka-createtopics-response-v6)
2222

2323
## Tests
2424

@@ -28,7 +28,7 @@ The tester will execute your program like this:
2828
./your_program.sh
2929
```
3030

31-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request with multiple topics.
31+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request with multiple topics.
3232

3333
The tester will validate that:
3434

stage_descriptions/create-topics-07_rk2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ TODO
1818

1919
We've created an interactive protocol inspector for the request & response structures for `CreateTopics`:
2020

21-
- 🔎 [CreateTopics Request (v7)](https://binspec.org/kafka-createtopics-request-v7)
22-
- 🔎 [CreateTopics Response (v7)](https://binspec.org/kafka-createtopics-response-v7)
21+
- 🔎 [CreateTopics Request (v6)](https://binspec.org/kafka-createtopics-request-v6)
22+
- 🔎 [CreateTopics Response (v6)](https://binspec.org/kafka-createtopics-response-v6)
2323

2424
We've also created an interactive protocol inspector for the `__cluster_metadata` topic's log file:
2525
- 🔎 [__cluster_metadata topic's log file](https://binspec.org/kafka-cluster-metadata)
@@ -32,7 +32,7 @@ The tester will execute your program like this:
3232
./your_program.sh
3333
```
3434

35-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request with valid parameters.
35+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request with valid parameters.
3636

3737
The tester will validate that:
3838

stage_descriptions/createtopics.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The tester will execute your program like this:
5252
./your_program.sh
5353
```
5454

55-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request with an invalid topic name.
55+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request with an invalid topic name.
5656

5757
The tester will validate that:
5858

@@ -88,7 +88,7 @@ The tester will execute your program like this:
8888
./your_program.sh
8989
```
9090

91-
It'll then connect to your server on port 9092 and send `CreateTopics` (v7) requests with invalid parameters.
91+
It'll then connect to your server on port 9092 and send `CreateTopics` (v6) requests with invalid parameters.
9292

9393
The tester will validate that:
9494

@@ -125,7 +125,7 @@ The tester will execute your program like this:
125125
# Then try to create the same topic again
126126
```
127127

128-
It'll then connect to your server on port 9092 and send a `CreateTopics` (v7) request for an existing topic.
128+
It'll then connect to your server on port 9092 and send a `CreateTopics` (v6) request for an existing topic.
129129

130130
The tester will validate that:
131131

@@ -162,7 +162,7 @@ The tester will execute your program like this:
162162
./your_program.sh
163163
```
164164

165-
It'll then connect to your server on port 9092 and send `CreateTopics` (v7) requests with invalid manual assignments.
165+
It'll then connect to your server on port 9092 and send `CreateTopics` (v6) requests with invalid manual assignments.
166166

167167
The tester will validate that:
168168

@@ -197,7 +197,7 @@ The tester will execute your program like this:
197197
./your_program.sh
198198
```
199199

200-
It'll then connect to your server on port 9092 and send `CreateTopics` (v7) requests without proper authorization.
200+
It'll then connect to your server on port 9092 and send `CreateTopics` (v6) requests without proper authorization.
201201

202202
The tester will validate that:
203203

0 commit comments

Comments
 (0)