This Adeo specification illustrates how ADEO uses AsyncAPI to document some of their exchanges
+- #costing
Servers
- kafka-secure://prod.url:9092/kafka-secureproduction
Kafka PRODUCTION cluster
+Security:
- API key
Use SASL authentication with SSL encryption to connect to the ADEO Broker.
+security.protocol:SASL_SSLsasl.mechanism:PLAIN
objectschemaRegistryUrlhttps://schema-registry.prod.url/ - kafka-secure://staging.url:9092/kafka-securestaging
Kafka STAGING cluster for
+uatandpreprodenvironmentsSecurity:
- API key
Use SASL authentication with SSL encryption to connect to the ADEO Broker.
+security.protocol:SASL_SSLsasl.mechanism:PLAIN
objectschemaRegistryUrlhttps://schema-registry.staging.url/ - kafka-secure://dev.url:9092/kafka-securedev
Kafka DEV cluster for
+devandsitenvironmentsSecurity:
- API key
Use SASL authentication with SSL encryption to connect to the ADEO Broker.
+security.protocol:SASL_SSLsasl.mechanism:PLAIN
objectschemaRegistryUrlhttps://schema-registry.dev.url/
Operations
SUB adeo-{env}-case-study-COSTING-REQUEST-{version}
Use this topic to do a Costing Request to Costing product. We use the RecordNameStrategy to infer the messages schema. You have to define
+x-value.subject.name.strategytoio.confluent.kafka.serializers.subject.RecordNameStrategyin your producer to use the schema we manage. The schema below illustrates how Costing Request messages are handled.![\\"\\"](\\"https://user-images.githubusercontent.com/5501911/188920831-689cec5f-8dc3-460b-8794-0b54ec8b0ac8.png\\")
[COSTING] Request one or more Costing calculation for any product +
You can try a costing request using our Conduktor producer template
+Operation IDrequestCostingAvailable only on servers:
objectenvrequiredstringAdeo Kafka Environment for messages publications.
+- Allowed values:
- "dev"
- "sit"
- "uat1"
- "preprod"
- "prod"
versionrequiredstringthe topic version you want to use
+Default value:"V1"- Examples values:
- "V1"
objectreplicas3partitions3objecttuple<string, ...optional<any>>1 item:deleteretention.ms604800000objectgroupIdstringThe groupId must be prefixed by your
+svcaccount, deliver by the Adeo Kafka team. Thissvcmust have the write access to the topic.x-value.subject.name.strategystringWe use the RecordNameStrategy to infer the messages schema. Use
+x-value.subject.name.strategy=io.confluent.kafka.serializers.subject.RecordNameStrategyin your producer configuration.- #costing
Accepts the following message:
Costing Request V1costingRequestCosting Request V1 inputs.
Message IDcostingRequestCorrelation ID$message.header#/REQUEST_IDThis correlation ID is used for message tracing and messages correlation. This correlation ID is generated at runtime based on the
+REQUEST_IDand sent to the RESPONSE message.PayloadrecordobjectREQUEST_IDrequiredstringformat: uuidA unique Request ID needed to define a
+CORRELATION_IDfor exchanges, which will be sent back in the Costing Responses.REPLY_TOPICrequiredstringThe Kafka topic where to send the Costing Response. This is required for the Return Address EIP pattern. You must grant WRITE access to our
+svc-ccr-appservice account.REQUESTER_IDrequiredstringThe Costing requester service account used to produce costing request.
+REQUESTER_CODErequiredstringThe Costing requester code (generally the BU Code). The requester code is useful to get the dedicated context (tenant).
+Additional properties are allowed.
- #costing
Examples
This example has been generated automatically.
+{ + \\"REQUEST_ID\\": \\"1fa6ef40-8f47-40a8-8cf6-f8607d0066ef\\", + \\"REPLY_TOPIC\\": \\"adeo-case-study-COSTING-RESPONSE-V1\\", + \\"REQUESTER_ID\\": \\"svc-ecollect-app\\", + \\"REQUESTER_CODE\\": 1 +} +This example has been generated automatically.
PUB adeo-{env}-case-study-COSTING-RESPONSE-{version}
This topic is used to REPLY Costing Requests and is targeted by the
+REPLY_TOPICheader. You must grant PUBLISH access to oursvc-ccr-appservice account.. We use the RecordNameStrategy to infer the messages schema. You have to definekey.subject.name.strategyandx-value.subject.name.strategytoio.confluent.kafka.serializers.subject.RecordNameStrategyin your consumer. The schema below illustrates how Costing Response messages are handled. +[COSTING] Get the costing responses matching an initial Costing Request. +
Operation IDgetCostingResponseAvailable only on servers:
objectenvrequiredstringAdeo Kafka Environment for messages publications.
+- Allowed values:
- "dev"
- "sit"
- "uat1"
- "preprod"
- "prod"
versionrequiredstringthe topic version you want to use
+Default value:"V1"- Examples values:
- "V1"
objectx-key.subject.name.strategystringWe use the RecordNameStrategy to infer the messages schema. Use
+x-key.subject.name.strategy=io.confluent.kafka.serializers.subject.RecordNameStrategyin your consumer configuration.x-value.subject.name.strategystringWe use the RecordNameStrategy to infer the messages schema. Use
+x-value.subject.name.strategy=io.confluent.kafka.serializers.subject.RecordNameStrategyin your consumer configuration.objectgroupIdstringThe groupId must be prefixed by your
+svcaccount, deliver by the Adeo Kafka team. Thissvcmust have the read access to the topic.- #costing
Accepts the following message:
Costing ResponsecostingResponseCosting Response ouputs.
Message IDcostingResponseCorrelation ID$message.header#/REQUEST_IDThis correlation ID is used for message tracing and messages correlation. This correlation ID is generated at runtime based on the
+REQUEST_IDand sent to the RESPONSE message.Please refer to the
+CostingResponseKey.avscschema, available on our github project.PayloadrecordobjectCALCULATION_IDstringformat: uuidA unique Message ID.
+CORRELATION_IDstringformat: uuidA unique Correlation ID defined from the
+REQUEST_IDor theMESSAGE_IDprovided in the Costing Request.REQUEST_TIMESTAMPstringformat: date-timeTimestamp of the costing request
+CALCULATION_TIMESTAMPstringformat: date-timeTechnical timestamp for the costing calculation
+Additional properties are allowed.
- #costing
Examples
This example has been generated automatically.
+{ + \\"CALCULATION_ID\\": \\"1fa6ef40-8f47-40a8-8cf6-f8607d0066ef\\", + \\"CORRELATION_ID\\": \\"1fa6ef40-8f47-40a8-8cf6-f8607d0066ef\\", + \\"REQUEST_TIMESTAMP\\": \\"2019-08-24T14:15:22Z\\", + \\"CALCULATION_TIMESTAMP\\": \\"2019-08-24T14:15:22Z\\" +} +This example has been generated automatically.
Messages
- #1Costing Request V1costingRequestV1
Costing Request V1 inputs.
Message IDcostingRequestV1Correlation ID$message.header#/REQUEST_IDThis correlation ID is used for message tracing and messages correlation. This correlation ID is generated at runtime based on the
+REQUEST_IDand sent to the RESPONSE message.PayloadrecordobjectREQUEST_IDrequiredstringformat: uuidA unique Request ID needed to define a
+CORRELATION_IDfor exchanges, which will be sent back in the Costing Responses.REPLY_TOPICrequiredstringThe Kafka topic where to send the Costing Response. This is required for the Return Address EIP pattern. You must grant WRITE access to our
+svc-ccr-appservice account.REQUESTER_IDrequiredstringThe Costing requester service account used to produce costing request.
+REQUESTER_CODErequiredstringThe Costing requester code (generally the BU Code). The requester code is useful to get the dedicated context (tenant).
+Additional properties are allowed.
- #costing
- #2Costing ResponsecostingResponse
Costing Response ouputs.
Message IDcostingResponseCorrelation ID$message.header#/REQUEST_IDThis correlation ID is used for message tracing and messages correlation. This correlation ID is generated at runtime based on the
+REQUEST_IDand sent to the RESPONSE message.Please refer to the
+CostingResponseKey.avscschema, available on our github project.PayloadrecordobjectCALCULATION_IDstringformat: uuidA unique Message ID.
+CORRELATION_IDstringformat: uuidA unique Correlation ID defined from the
+REQUEST_IDor theMESSAGE_IDprovided in the Costing Request.REQUEST_TIMESTAMPstringformat: date-timeTimestamp of the costing request
+CALCULATION_TIMESTAMPstringformat: date-timeTechnical timestamp for the costing calculation
+Additional properties are allowed.
- #costing
Schemas
- RequesterIdstring
The Costing requester service account used to produce costing request.
+ - RequesterCodestring
The Costing requester code (generally the BU Code). The requester code is useful to get the dedicated context (tenant).
+ - MessageIdstringformat: uuid
A unique Message ID.
+ - RequestIdstringformat: uuid
A unique Request ID needed to define a
+CORRELATION_IDfor exchanges, which will be sent back in the Costing Responses. - CorrelationIdstringformat: uuid
A unique Correlation ID defined from the
+REQUEST_IDor theMESSAGE_IDprovided in the Costing Request. - BuCodestring
The Business Unit code for which data are applicable.
+ - ReplyTopicstring
The Kafka topic where to send the Costing Response. This is required for the Return Address EIP pattern. You must grant WRITE access to our
+svc-ccr-appservice account. - ErrorStepstring
The woker that has thrown the error.
+ - ErrorMessagestring
The error message describing the error.
+ - ErrorCodestring
The error code.
+