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.

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

docs: fix adeo-kafka-request-reply-asyncapi.yml #1034

Merged
Changes from all commits
Commits
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
30 changes: 20 additions & 10 deletions examples/adeo-kafka-request-reply-asyncapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -206,59 +206,69 @@ components:
RequesterId:
type: string
description: The Costing requester service account used to produce costing request.
example: svc-ecollect-app
examples:
- svc-ecollect-app
RequesterCode:
type: string
description: >-
The Costing requester code (generally the BU Code). The requester code
is useful to get the dedicated context (tenant).
example: 1
examples:
- 1
MessageId:
type: string
format: uuid
description: A unique Message ID.
example: 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
examples:
- 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
RequestId:
type: string
format: uuid
description: >-
A unique Request ID needed to define a `CORRELATION_ID` for exchanges,
which will be sent back in the Costing Responses.
example: 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
examples:
- 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
CorrelationId:
type: string
format: uuid
description: >-
A unique Correlation ID defined from the `REQUEST_ID` or the
`MESSAGE_ID` provided in the Costing Request.
example: 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
examples:
- 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef
BuCode:
type: string
description: The Business Unit code for which data are applicable.
example: 1
examples:
- 1
ReplyTopic:
type: string
description: >
The Kafka topic where to send the Costing Response. This is required for
the [Return Address EIP
pattern](https://www.enterpriseintegrationpatterns.com/patterns/messaging/ReturnAddress.html).
**You must grant WRITE access to our `svc-ccr-app` service account.**
example: adeo-case-study-COSTING-RESPONSE-V1
examples:
- adeo-case-study-COSTING-RESPONSE-V1
ErrorStep:
type: string
description: |
The woker that has thrown the error.
example: EXPOSE_RESULT
examples:
- EXPOSE_RESULT
ErrorMessage:
type: string
description: |
The error message describing the error.
example: Error message
examples:
- Error message
ErrorCode:
type: string
description: |
The error code.
example: CURRENCY_NOT_FOUND
examples:
- CURRENCY_NOT_FOUND
parameters:
Env:
description: Adeo Kafka Environement for messages publications.
Expand Down
Loading