Skip to content

Commit

Permalink
chore: update ApiType values
Browse files Browse the repository at this point in the history
related-to APIM-718
  • Loading branch information
leleueri committed Mar 9, 2023
1 parent a7857d7 commit 5e689af
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 Down Expand Up @@ -67,7 +67,7 @@ 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,
----
Expand Down
4 changes: 2 additions & 2 deletions pages/apim/3.x/v4/event-native-tutorials-kafka-http.adoc
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 Down Expand Up @@ -46,7 +46,7 @@ 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,
----
Expand Down
4 changes: 2 additions & 2 deletions pages/apim/3.x/v4/event-native-tutorials-kafka-sse.adoc
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 @@ -37,7 +37,7 @@ 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,
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ 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,
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before running this tutorial, you must have:

1. In the Tutorials Postman Collection, open the `Kafka and Websockets` 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, a `websocket` 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, a `websocket` 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 @@ -38,7 +38,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
"name": "Demo of Kafka and Websockets",
"apiVersion": "1.0.0",
"definitionVersion": "4.0.0",
"type": "async",
"type": "message",
"createdAt": 1675674428097,
"updatedAt": 1675674428097,
----
Expand Down
4 changes: 2 additions & 2 deletions pages/apim/3.x/v4/event-native-tutorials-mqtt-http.adoc
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 `MQTT 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 `entrypoints` 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 `mqtt5` endpoint, which connects to the host `hivemq` on port `1883`.
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 `entrypoints` 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 `mqtt5` endpoint, which connects to the host `hivemq` on port `1883`.
+
If you look under `endpoints` you will see the following code.
+
Expand Down Expand Up @@ -46,7 +46,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
"name": "Demo of HTTP Post + MQTT",
"apiVersion": "1.0.0",
"definitionVersion": "4.0.0",
"type": "async",
"type": "message",
"createdAt": 1674818407231,
"updatedAt": 1674818407231,
----
Expand Down
4 changes: 2 additions & 2 deletions pages/apim/3.x/v4/event-native-tutorials-mqtt-sse.adoc
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 `MQTT 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 `entrypoints` you can see that we are creating one entrypoint, as `sse` entrypoint. Under `endpointGroups` you can see that we are creating one `mqtt5` endpoint, which connects to the host `hivemq` on port `1883`.
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 `entrypoints` you can see that we are creating one entrypoint, as `sse` entrypoint. Under `endpointGroups` you can see that we are creating one `mqtt5` endpoint, which connects to the host `hivemq` on port `1883`.
+
[TIP]
====
Expand All @@ -35,7 +35,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
"name": "MQTT and SSE",
"apiVersion": "1.0.0",
"definitionVersion": "4.0.0",
"type": "async",
"type": "message",
"createdAt": 1675694466958,
"updatedAt": 1675694466958,
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
"name": "Demo of Webhook + MQTT - Subscription Filtering",
"apiVersion": "1.0.0",
"definitionVersion": "4.0.0",
"type": "async",
"type": "message",
"createdAt": 1675090250286,
"updatedAt": 1675090250286,
----
Expand Down
4 changes: 2 additions & 2 deletions pages/apim/3.x/v4/event-native-tutorials-mqtt-websockets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before running this tutorial, you must have:

1. In the Tutorials Postman Collection, open the `MQTT and Websockets` 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 `entrypoints` you can see that we are creating one entrypoint, a `websocket` entrypoint. Under `endpointGroups` you can see that we are creating one `mqtt5` endpoint, which connects to the host `hivemq` on port `1883`.
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 `entrypoints` you can see that we are creating one entrypoint, a `websocket` entrypoint. Under `endpointGroups` you can see that we are creating one `mqtt5` endpoint, which connects to the host `hivemq` on port `1883`.
+
[TIP]
====
Expand All @@ -36,7 +36,7 @@ For full details about the structure of the body, see link:{{'/apim/3.x/manageme
"name": "Demo of Websocket + MQTT",
"apiVersion": "1.0.0",
"definitionVersion": "4.0.0",
"type": "async",
"type": "message",
"createdAt": 1675164433265,
"updatedAt": 1675164433265,
----
Expand Down
2 changes: 1 addition & 1 deletion pages/apim/3.x/v4/v4-event-native-apim-user-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ For example, to create an HTTP POST entrypoint that connects to a Kafka endpoint
"name": "Data Ingestion to Kafka",
"apiVersion": "1.0",
"definitionVersion": "4.0.0",
"type": "async",
"type": "message",
"description": "Data Ingestion to Kafka",
"listeners": [
{
Expand Down

0 comments on commit 5e689af

Please sign in to comment.