From f251376d353b04d836e441c428a863b0d623d1fe Mon Sep 17 00:00:00 2001 From: Haris Osmanagic Date: Fri, 3 May 2024 18:41:23 +0200 Subject: [PATCH] markdown linter --- .../20240430-schema-support.md | 47 ++++++++++--------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/docs/design-documents/20240430-schema-support.md b/docs/design-documents/20240430-schema-support.md index 483ae0483..a0d34c5ec 100644 --- a/docs/design-documents/20240430-schema-support.md +++ b/docs/design-documents/20240430-schema-support.md @@ -23,9 +23,9 @@ the [target collections](https://conduit.io/docs/introduction/vocabulary). To do so, the following is required: -* collection name -* collection metadata -* schema +- collection name +- collection metadata +- schema This design document focuses on the schema support in Conduit in the context of the above. @@ -65,26 +65,27 @@ connector developer to write code, since it doesn't require handling of potentially multiple schema types. A schema consists of following: -* reference: a string that uniquely identifies a schema in Conduit -* list of fields, where each field is described with following: - * name - * type - * optional (boolean value) - * default value +- reference: a string that uniquely identifies a schema in Conduit +- list of fields, where each field is described with following: + - name + - type + - optional (boolean value) + - default value The following types are supported: -* basic: - * boolean - * integers: 8, 16, 32, 64-bit - * float: single precision (32-bit) and double precision (64-bit) IEEE 754 floating-point number - * bytes - * string - * timestamp -* complex: - * array - * map - * struct - * union + +- basic: + - boolean + - integers: 8, 16, 32, 64-bit + - float: single precision (32-bit) and double precision (64-bit) IEEE 754 floating-point number + - bytes + - string + - timestamp +- complex: + - array + - map + - struct + - union Every field in a schema can be marked as optional (nullable). @@ -99,6 +100,8 @@ connectors with Conduit. Here we have two possibilities: 1. The schema is part of the record (e.g. Debezium records) 2. The schema can be found in a schema registry (e.g. an Avro schema registry) +TBD + ## Schema evolution TBD (this section is about checking if a new version of a schema is compatible @@ -275,4 +278,4 @@ remote Conduit instances. 1. **Permissions**: creating a collection generally requires a broader set of permissions then just writing data to a collection. For some users, the benefit of having restricted permissions might outweigh the benefit of - auto-creating collections. \ No newline at end of file + auto-creating collections.