Skip to content

edit: update Kafka2Rest plugin doc #2695

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

Open
nicola88 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

edit: update Kafka2Rest plugin doc #2695

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions docs/runtime-components/plugins/kafka2rest-service/02_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ an instance of `Kafka2Rest` service.
- `TOPICS_REST_CONFIG_PATH`: the path where is located the _kafka-topic_:_base-url_ configuration map
- `PATH_PROCESSORS_PATH`: the path where is located the path processors Javascript file
- `BODY_PROCESSORS_PATH`: the path where is located the request body processors Javascript file
- `HEADER_PROCESSORS_PATH`: the path where is located the request header processors Javascript file
- `VALIDATOR_PROCESSORS_PATH`: the path where is located the message validator processors Javascript file
- `KAFKA_CLIENT_ID`: the identifier which can be employed to recognize this service within Kafka environment
- `KAFKA_GROUP_ID`: the consumer group identifier employed by the service to read messages from Kafka
Expand All @@ -43,17 +44,16 @@ Here is provided the JSON schema that defines the configuration for each topic
"type": "object",
"required": [
"baseUrl",
"messageSchema",
"pathProcessor",
"bodyProcessor"
],
"properties": {
"authentication": {
"type": "string",
"enum": ["none", "basic", "privateKeyJwt"],
"default": "none",
"description": "specify (optionally) the way the service should request a token to the client credentials to authenticate the request to the target url"
},
"type": "string",
"enum": ["none", "basic", "privateKeyJwt"],
"default": "none",
"description": "specify (optionally) the way the service should request a token to the client credentials to authenticate the request to the target url"
},
"baseUrl": {
"type": "string",
"description": "the target base url onto which requests should be performed. This MUST terminate with a /"
Expand All @@ -70,6 +70,10 @@ Here is provided the JSON schema that defines the configuration for each topic
"type": "string",
"description": "the name of a body processor to be employed to generate the request body - selected from one of the available in bodyProcessors file"
},
"headerProcessor": {
"type": "string",
"description": "the name of a header processor to be employed to generate the request headers - selected from one of the available in headerProcessors file"
},
"validatorProcessor": {
"type": "string",
"description": "the name of a validator processor to be employed to filter invalid message - selected from one of the available in validatorProcessor file"
Expand Down
Loading