Add metadata field to low-code schema (#27094)

* add metadata field to low-code schema * Automated Commit - Formatting Changes * update wording of description * fix formatting --------- Co-authored-by: lmossman <lmossman@users.noreply.github.com>
airbytehq · Jun 8, 2023 · a2c57c4 · a2c57c4
1 parent 083667a
commit a2c57c4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/airbyte-cdk/python/airbyte_cdk/sources/declarative/declarative_component_schema.yaml b/airbyte-cdk/python/airbyte_cdk/sources/declarative/declarative_component_schema.yaml
@@ -27,6 +27,10 @@ properties:
     type: object
   spec:
     "$ref": "#/definitions/Spec"
+  metadata:
+    type: object
+    description: For internal Airbyte use only - DO NOT modify manually. Used by consumers of declarative manifests for storing related metadata.
+    additionalProperties: true
 additionalProperties: false
 definitions:
   AddedFieldDefinition:

diff --git a/airbyte-cdk/python/airbyte_cdk/sources/declarative/models/declarative_component_schema.py b/airbyte-cdk/python/airbyte_cdk/sources/declarative/models/declarative_component_schema.py
@@ -1095,6 +1095,10 @@ class Config:
     schemas: Optional[Schemas] = None
     definitions: Optional[Dict[str, Any]] = None
     spec: Optional[Spec] = None
+    metadata: Optional[Dict[str, Any]] = Field(
+        None,
+        description="For internal Airbyte use only - DO NOT modify manually. Used by consumers of declarative manifests for storing related metadata.",
+    )
 
 
 class DeclarativeStream(BaseModel):