Merge pull request #101 from bitol-io/dev-kafkaexamples

Kafka schema examples

Author: pflooky

CHANGELOG.md

@@ -6,7 +6,7 @@ image: "https://raw.githubusercontent.com/bitol-io/artwork/main/horizontal/color
 
 This document tracks the history and evolution of the **Open Data Contract Standard**.
 
-# v3.0.0 - 2024-10-05 - APPROVED
+# v3.0.0 - 2024-10-21 - APPROVED
 
 * **New section**: Support & communication channels.
 * **New section**: Servers.

docs/README.md

@@ -43,7 +43,7 @@ This section contains general information about the contract.
 ### Example
 
 ```YAML
-apiVersion: 3.0.0 # Standard version
+apiVersion: v3.0.0 # Standard version
 kind: DataContract
 
 id: 53581432-6c55-4ba2-a65f-72344a91553a

docs/examples/schema/kafka-schema.odcs.yaml

@@ -0,0 +1,33 @@
+apiVersion: v3.0.0
+kind: DataContract
+id: orders
+status: development
+name: Orders Event Stream
+version: 0.0.1
+schema:
+- name: Orders
+  physicalName: orders
+  logicalType: object
+  physicalType: topic
+  description: Orders Kafka topic
+  properties:
+    - name: cust_id
+      businessName: Customer ID
+      logicalType: string
+      physicalType: string
+      required: true
+    - name: prod_id
+      businessName: Product ID
+      logicalType: string
+      physicalType: string
+      required: true      
+    - name: qty
+      businessName: Quantity
+      logicalType: integer
+      physicalType: int
+      required: true        
+servers:
+- server: my-kafka
+  type: kafka
+  format: avro
+  host: kafkabroker1:9092

docs/examples/schema/kafka-schemaregistry.odcs.yaml

@@ -0,0 +1,20 @@
+apiVersion: v3.0.0
+kind: DataContract
+id: orders
+status: production
+name: Orders Event Stream
+version: 0.0.1
+schema:
+- name: Orders
+  physicalName: orders
+  logicalType: object
+  physicalType: topic
+  description: Orders Kafka topic
+  authoritativeDefinitions:
+    - url: https://schema-registry:8081
+      type: implementation
+servers:
+- server: my-kafka
+  type: kafka
+  format: avro
+  host: kafkabroker1:9092