gravitee-io · leleueri · Mar 9, 2023 · Mar 9, 2023 · Mar 9, 2023 · Mar 9, 2023
@@ -1,6 +1,6 @@
 {
 	"id": "b4e3dfcd-cf7b-4a51-ad36-981640660686",
-	"name": "Gravitee APIM 3.20 Tutorials Environment",
+	"name": "Gravitee APIM 3.21 Tutorials Environment",
 	"values": [
 		{
 			"key": "management_host",

@@ -29,7 +29,7 @@ For more information about installing plugins, see link:{{'/apim/3.x/apim_devgui
 
 2. Under "Cluster Overview" in the left-hand menu, click "Cluster Settings".
 
-3. Copy the Bootstrap server host and port from the Endpoints pane and paste it into the `CURRENT VALUE` field for the `kafkabootstrap` variable in the APIM 3.20 Tutorials Environment in Postman. Click Save.
+3. Copy the Bootstrap server host and port from the Endpoints pane and paste it into the `CURRENT VALUE` field for the `kafkabootstrap` variable in the APIM 3.21 Tutorials Environment in Postman. Click Save.
 
 4. In Confluent Cloud, under "Cluster Overview", click "API Keys" and then click "+ Add Key". Create a Global Access key
 
@@ -39,7 +39,7 @@ For more information about installing plugins, see link:{{'/apim/3.x/apim_devgui
 
 1. In the Tutorials Postman Collection, open the `Kafka Advanced, HTTP, and Confluent Cloud` folder.
 
-2. Open the `Create the API` request and look at the request body. Note that the `definitionVersion` is `4.0.0` and the `type` is `async`. This means we are using the Gravitee 4.0.0 OpenAPI specification to create an asynchronous API. If you look under `listeners` you can see that we are creating two entrypoints, an `http-post` entrypoint and an `http-get` entrypoint. 
+2. Open the `Create the API` request and look at the request body. Note that the `definitionVersion` is `4.0.0` and the `type` is `message`. This means we are using the Gravitee 4.0.0 OpenAPI specification to create an asynchronous API. If you look under `listeners` you can see that we are creating two entrypoints, an `http-post` entrypoint and an `http-get` entrypoint. 
 +
 Under `endpointGroups` you can see that we are creating one `kafka-advanced` endpoint, which uses the bootstrap server specified by the `kafkabootstrap` variable. The `security` object contains the authentication information to allow the gateway to connect to Kafka. In this case we are using SASL.
 +
@@ -56,7 +56,7 @@ If you look under `endpoints` you will see the following code.
 +
 This is necessary to allow the API to consume data from Kafka.
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
 
 3. Send the request. You should receive a response that starts like this.
 +
@@ -67,12 +67,12 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
     "name": "Kafka, HTTP, and Confluent Cloud",
     "apiVersion": "1.0",
     "definitionVersion": "4.0.0",
-    "type": "async",
+    "type": "message",
     "createdAt": 1675332450547,
     "updatedAt": 1675332450547,
 ----
 +
-The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Creating a keyless plan
 
@@ -91,7 +91,7 @@ The `id` is the ID of the API we just created. Copy the ID, and paste it into th
 }
 ----
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
 
 2. Send the request. You should receive a response that starts like this.
 +
@@ -108,7 +108,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
 +
 The `id` is the ID of the plan we just created.
 
-3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Starting the API
 
@@ -238,7 +238,7 @@ We are now going to modify the API so that it uses a rate-limiting plan.
 +
 These lines specify the rate limit of one request per 20 seconds.
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
 
 3. Send the request. You should receive a response that starts like this.
 +
@@ -255,7 +255,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
 +
 The `id` is the ID of the API we just created.
 
-4. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+4. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 5. Select the `Push Data` request and send it four times in quick succession. Note that all the requests are accepted.
 

@@ -17,7 +17,7 @@ Before running this tutorial, you must have:
 
 1. In the Tutorials Postman Collection, open the `Kafka and HTTP` folder.
 
-2. Open the `Create the API` request and look at the request body. Note that the `definitionVersion` is `4.0.0` and the `type` is `async`. This means we are using the Gravitee 4.0.0 OpenAPI specification to create an asynchronous API. If you look under `listeners` you can see that we are creating two entrypoints, an `http-post` entrypoint and an `http-get` entrypoint. Under `endpointGroups` you can see that we are creating one `kafka` endpoint, which uses a bootstrap server called `kafka` on port `9092`. The `topics` array contains just one topic, `demo`.
+2. Open the `Create the API` request and look at the request body. Note that the `definitionVersion` is `4.0.0` and the `type` is `message`. This means we are using the Gravitee 4.0.0 OpenAPI specification to create an asynchronous API. If you look under `listeners` you can see that we are creating two entrypoints, an `http-post` entrypoint and an `http-get` entrypoint. Under `endpointGroups` you can see that we are creating one `kafka` endpoint, which uses a bootstrap server called `kafka` on port `9092`. The `topics` array contains just one topic, `demo`.
 +
 If you look under `endpoints` you will see the following code.
 +
@@ -35,7 +35,7 @@ This is necessary to allow the API to consume data from Kafka.
 APIM and AKHQ are both running on the Docker bridge network called `storage`. The host `kafka` is a host on that network.
 ====
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
 
 3. Send the request. You should receive a response that starts like this.
 +
@@ -46,12 +46,12 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
     "name": "Kafka and HTTP",
     "apiVersion": "1.0",
     "definitionVersion": "4.0.0",
-    "type": "async",
+    "type": "message",
     "createdAt": 1675332450547,
     "updatedAt": 1675332450547,
 ----
 +
-The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Creating a keyless plan
 
@@ -70,7 +70,7 @@ The `id` is the ID of the API we just created. Copy the ID, and paste it into th
 }
 ----
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
 
 2. Send the request. You should receive a response that starts like this.
 +
@@ -87,7 +87,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
 +
 The `id` is the ID of the plan we just created.
 
-3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Starting the API
 
@@ -217,7 +217,7 @@ We are now going to modify the API so that it uses a rate-limiting plan.
 +
 These lines specify the rate limit of one request per 20 seconds.
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
 
 3. Send the request. You should receive a response that starts like this.
 +
@@ -234,7 +234,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
 +
 The `id` is the ID of the API we just created.
 
-4. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+4. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 5. Select the `Push Data` request and send it four times in quick succession. Note that all the requests are accepted.
 

@@ -17,7 +17,7 @@ Before running this tutorial, you must have:
 
 1. In the Tutorials Postman Collection, open the `Kafka and SSE` folder.
 
-2.  Open the `Create the API` request and look at the request body. Note that the `definitionVersion` is `4.0.0` and the `type` is `async`. This means we are using the Gravitee 4.0.0 OpenAPI specification to create an asynchronous API. If you look under `listeners` you can see that we are creating two entrypoints, an `sse` entrypoint, and an `http-post` entrypoint. In this tutorial the `http-post` entrypoint is only used for publishing data to Kafka. For a full tutorial on Kafka and HTTP, see link:{{ '/apim/3.x/event_native_tutorials_kafka_websockets.html' | relative_url }}[Kafka and HTTP].
+2.  Open the `Create the API` request and look at the request body. Note that the `definitionVersion` is `4.0.0` and the `type` is `message`. This means we are using the Gravitee 4.0.0 OpenAPI specification to create an asynchronous API. If you look under `listeners` you can see that we are creating two entrypoints, an `sse` entrypoint, and an `http-post` entrypoint. In this tutorial the `http-post` entrypoint is only used for publishing data to Kafka. For a full tutorial on Kafka and HTTP, see link:{{ '/apim/3.x/event_native_tutorials_kafka_websockets.html' | relative_url }}[Kafka and HTTP].
 +
 Under `endpointGroups` you can see that we are creating one `kafka` endpoint, which uses a bootstrap server called `kafka` on port `9092`. The `topics` array contains just one topic, `demo`.
 +
@@ -26,7 +26,7 @@ Under `endpointGroups` you can see that we are creating one `kafka` endpoint, wh
 APIM and AKHQ are both running on the Docker bridge network called `storage`. The host `kafka` is a host on that network.
 ====
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
 
 3. Send the request. You should receive a response that starts like this.
 +
@@ -37,12 +37,12 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
     "name": "Kafka and SSE",
     "apiVersion": "1.0.0",
     "definitionVersion": "4.0.0",
-    "type": "async",
+    "type": "message",
     "createdAt": 1675699730275,
     "updatedAt": 1675699730275,
 ----
 +
-The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Creating a keyless plan
 
@@ -61,7 +61,7 @@ The `id` is the ID of the API we just created. Copy the ID, and paste it into th
 }
 ----
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
 
 2. Send the request. You should receive a response that starts like this.
 +
@@ -78,7 +78,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
 +
 The `id` is the ID of the plan we just created.
 
-3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Starting the API
 

@@ -26,7 +26,7 @@ Under `endpointGroups` you can see that we are creating one `kafka` endpoint, wh
 APIM and AKHQ are both running on the Docker bridge network called `storage`. The host `kafka` is a host on that network.
 ====
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-APIs' | relative_url}}[V4 - APIs] reference documentation.
 
 3. Send the request. You should receive a response that starts like this.
 +
@@ -37,12 +37,12 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
     "name": "Kafka and Webhooks",
     "apiVersion": "1.0.0",
     "definitionVersion": "4.0.0",
-    "type": "async",
+    "type": "message",
     "createdAt": 1675347679105,
     "updatedAt": 1675347679105,
 ----
 +
-The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+The `id` is the ID of the API we just created. Copy the ID, and paste it into the `CURRENT VALUE` field for the `api` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Creating plans
 
@@ -63,7 +63,7 @@ We need to create two plans: a keyless plan to allow us to publish to Kafka over
 }
 ----
 +
-For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.20/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
+For full details about the structure of the body, see link:{{'/apim/3.x/management-api/3.21/#tag/V4-API-Plans/operation/createApiPlan_1' | relative_url}}[Create a plan] reference documentation.
 
 2. Send the request. You should receive a response that starts like this.
 +
@@ -80,7 +80,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
 +
 The `id` is the ID of the plan we just created.
 
-3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 4. Select the `Create an Open (Subscription) Plan` request and look at the request body. It looks like this.
 +
@@ -112,7 +112,7 @@ The `id` is the ID of the plan we just created.
 +
 The `id` is the ID of the plan we just created.
 
-6. Copy the ID, and paste it into the `CURRENT VALUE` field for the `subplan` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+6. Copy the ID, and paste it into the `CURRENT VALUE` field for the `subplan` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 == Starting the API
 
@@ -142,11 +142,11 @@ We are now going to create an application and use that application to subscribe
     "updated_at": 1675347893455,
 ----
 
-3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `application` variable in the APIM 3.20 Tutorials Environment. Click Save. 
+3. Copy the ID, and paste it into the `CURRENT VALUE` field for the `application` variable in the APIM 3.21 Tutorials Environment. Click Save. 
 
 4. Go to https://webhook.site/ and follow the instructions there to create a callback URL. Do not close the browser window.
 
-5. Copy the callback URL, and paste it into the `CURRENT VALUE` field for the `callback-url` variable in the APIM 3.20 Tutorials.
+5. Copy the callback URL, and paste it into the `CURRENT VALUE` field for the `callback-url` variable in the APIM 3.21 Tutorials.
 
 6. Select the `Subscribe to API` request. If you look at the body of the request, you will see name-value pairs for custom headers, and a `metadata` object. These will become useful later. Send the request. You should see a response that begins like this.
 +
@@ -162,7 +162,7 @@ We are now going to create an application and use that application to subscribe
         "id": "886966ce-1dab-48b1-a966-ce1dab68b17d",
 ----
 
-7.  Copy the top-level ID, and paste it into the `CURRENT VALUE` field for the `subscription` variable in the APIM 3.20 Tutorials Environment. Click Save.
+7.  Copy the top-level ID, and paste it into the `CURRENT VALUE` field for the `subscription` variable in the APIM 3.21 Tutorials Environment. Click Save.
 
 8. In Postman, select the `Push Data` request and look at the request body. It looks like this.
 +
@@ -256,6 +256,6 @@ You will see the message does appear in the `webhook.site` window, because the f
 
 == Close the plan and delete the API
 
-After finishing this tutorial, run the `Stop the API`, `Close plan`, and `Delete API` requests in the `Delete API` folder in Postman. This removes the plan and API. You will also have to copy the `CURRENT VALUE` of `subplan` into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.20 Tutorials Environment, click Save, and then re-run `Close plan` to remove the subscription plan.
+After finishing this tutorial, run the `Stop the API`, `Close plan`, and `Delete API` requests in the `Delete API` folder in Postman. This removes the plan and API. You will also have to copy the `CURRENT VALUE` of `subplan` into the `CURRENT VALUE` field for the `plan` variable in the APIM 3.21 Tutorials Environment, click Save, and then re-run `Close plan` to remove the subscription plan.
 
 Alternatively, you can delete all Docker containers and volumes.