Skip to content

Commit

Permalink
Adjust documentation per rawPayload=true requirements (#4086)
Browse files Browse the repository at this point in the history
* Adjust documentation per `rawPayload=true` requirements

Signed-off-by: Patrick Assuied <patrick.assuied@elationhealth.com>

* small tweak

Signed-off-by: Patrick Assuied <patrick.assuied@elationhealth.com>

* PR feedback

Signed-off-by: Patrick Assuied <patrick.assuied@elationhealth.com>

* more editing

Signed-off-by: Patrick Assuied <patrick.assuied@elationhealth.com>

---------

Signed-off-by: Patrick Assuied <patrick.assuied@elationhealth.com>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>
  • Loading branch information
passuied and yaron2 committed Apr 9, 2024
1 parent f1d1124 commit 5c92fd5
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,8 @@ You can configure pub/sub to publish or consume data encoded using [Avro binary
### Configuration

{{% alert title="Important" color="warning" %}}
Currently, only message value serialization/deserialization is supported. Since cloud events are not supported, the `rawPayload=true` metadata must be passed.
Currently, only message value serialization/deserialization is supported. Since cloud events are not supported, the `rawPayload=true` metadata must be passed when publishing Avro messages.
Please note that `rawPayload=true` should NOT be set for consumers, as the message value will be wrapped into a CloudEvent and base64-encoded. Leaving `rawPayload` as default (i.e. `false`) will send the Avro-decoded message to the application as a JSON payload.
{{% /alert %}}

When configuring the Kafka pub/sub component metadata, you must define:
Expand Down Expand Up @@ -533,7 +534,6 @@ def subscribe():
'topic': 'my-topic',
'route': 'my_topic_subscriber',
'metadata': {
'rawPayload': 'true',
'valueSchemaType': 'Avro',
} }]
return subscriptions
Expand Down

0 comments on commit 5c92fd5

Please sign in to comment.