From 307672ad7a1e95c4c84d281c2fd407e211071660 Mon Sep 17 00:00:00 2001 From: jochenchrist Date: Mon, 21 Oct 2024 11:04:11 +0200 Subject: [PATCH 1/3] Fix apiVersion Spec and Schema says v3.0.0 instead of 3.0.0 --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 26d0b69..2905046 100644 --- a/docs/README.md +++ b/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 From 66b46a3b6be29f71866653b509139efa1b439948 Mon Sep 17 00:00:00 2001 From: "Jean-Georges \"jgp\" Perrin" Date: Mon, 21 Oct 2024 08:45:44 -0400 Subject: [PATCH 2/3] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ccf059d..cc19e4b 100644 --- a/CHANGELOG.md +++ b/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. From 2ebe21b3ee8897f9da114fbeb29034a95879812b Mon Sep 17 00:00:00 2001 From: Dirk Van de Poel Date: Thu, 5 Dec 2024 21:21:40 +0100 Subject: [PATCH 3/3] Kafka schema examples Kafka schema examples, one with an inline example and another with an authoritativeDefinitions reference to an external Kafka schema registry. Signed-off-by: Dirk Van de Poel --- docs/examples/schema/kafka-schema.odcs.yaml | 33 +++++++++++++++++++ .../schema/kafka-schemaregistry.odcs.yaml | 20 +++++++++++ 2 files changed, 53 insertions(+) create mode 100644 docs/examples/schema/kafka-schema.odcs.yaml create mode 100644 docs/examples/schema/kafka-schemaregistry.odcs.yaml diff --git a/docs/examples/schema/kafka-schema.odcs.yaml b/docs/examples/schema/kafka-schema.odcs.yaml new file mode 100644 index 0000000..b264dca --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/examples/schema/kafka-schemaregistry.odcs.yaml b/docs/examples/schema/kafka-schemaregistry.odcs.yaml new file mode 100644 index 0000000..b418954 --- /dev/null +++ b/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 \ No newline at end of file