Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update ApiType values #1001

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

chore: update ApiType values #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59bdecf
chore: update ApiType values
leleueri Mar 9, 2023
8679b10
Changing file versions
AndrewMcFarlandCampbellGravitee Mar 9, 2023
bfdd41a
Merge branch 'master' into apim-718-rename-v4-terms
AndrewMcFarlandCampbellGravitee Mar 9, 2023
db5e891
Synchronising with master and removing final uses of `"async"`
AndrewMcFarlandCampbellGravitee Mar 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ials Environment.postman_environment.json → ...ials Environment.postman_environment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
114 changes: 57 additions & 57 deletions ...IM 3.20 Tutorials.postman_collection.json → ...IM 3.21 Tutorials.postman_collection.json
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions pages/apim/3.x/v4/event-native-tutorials-kafka-advanced-http.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
+
Expand All @@ -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.
+
Expand All @@ -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

Expand All @@ -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.
+
Expand All @@ -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

Expand Down Expand Up @@ -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.
+
Expand All @@ -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.

Expand Down
16 changes: 8 additions & 8 deletions pages/apim/3.x/v4/event-native-tutorials-kafka-http.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
+
Expand All @@ -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.
+
Expand All @@ -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

Expand All @@ -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.
+
Expand All @@ -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

Expand Down Expand Up @@ -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.
+
Expand All @@ -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.

Expand Down
14 changes: 7 additions & 7 deletions pages/apim/3.x/v4/event-native-tutorials-kafka-sse.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
+
Expand All @@ -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.
+
Expand All @@ -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

Expand All @@ -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.
+
Expand All @@ -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

Expand Down Expand Up @@ -141,7 +141,7 @@ Flows can be added at a number of different specificity levels, including the AP
"name": "Kafka and SSE - Subscription Filtering",
"apiVersion": "1.0.0",
"definitionVersion": "4.0.0",
"type": "async",
"type": "message",
"deployedAt": 1675699816300,
----

Expand Down
Loading