Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update k_schemas.md

Browse Source
This commit is contained in:
adiglp
2025-06-10 15:34:22 +02:00
committed by GitHub
parent 84e6c914a1
commit c41a9a0685
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
asynchronous-api-guidelines/kafka-asynchronous-guidelines/k_schemas.md
View File

@@ -14,18 +14,24 @@ channels:
publish:
...
message:
$ref: '#/components/messages/topic1Payload'
$ref: '#/components/messages/namespace.source.event.topic-name'
components:
...
schemas:
...
topic1SchemaValue:
schemaFormat: 'application/vnd.apache.avro;version=1.9.0'
payload:
$ref: https://sit-fdp-pivotal-schema-registry.api.3stripes.io/subjects/pea_fd_fdp.sample.test-value/versions/latest/schema
messages:
topic1Payload:
$ref: '#/components/schemas/topic1SchemaValue'
namespace.source.event.topic-name:
$ref: '#/components/schemas/namespace.source.event.topic-name'
...
schemas:
namespace.source.event.topic-name:
description: 'Schema[s] retrieved from Schema Registry'
schemaFormat: 'application/vnd.apache.avro;version=1.9.0'
payload:
$ref: 'https://dev-fdp-playground-schema-registry.api.3stripes.io/subjects/namespace.source.event.topic-name-value/versions/latest/schema'
bindings:
kafka:
key:
$ref: 'https://dev-fdp-playground-schema-registry.api.3stripes.io/subjects/namespace.source.event.topic-name-key/versions/latest/schema'
```
**Important note** The used schema is a very simple one, it is only used to illustrate how to refer to it.
**Important note** The used schema is a very simple one, it is only used to illustrate how to refer to it. In case the message doesn't use schema for the key, _bindings_ field can be omitted from the schema.