Refactor input/output types

docs/docs/schema/pipeline.json

@@ -31,7 +31,7 @@
             "description": "Input topic",
             "properties": {
                 "role": {
-                    "description": "Custom identifier belonging to a topic, provide only if `type` is `extra` or `extra-pattern`",
+                    "description": "Custom identifier belonging to a topic, provide only if `type` is `extra`, `pattern` or `extra-pattern`",
                     "title": "Role",
                     "type": "string"
                 },
@@ -41,12 +41,10 @@
                             "$ref": "#/definitions/InputTopicTypes"
                         }
                     ],
+                    "default": "input",
                     "description": "Topic type"
                 }
             },
-            "required": [
-                "type"
-            ],
             "title": "FromTopic",
             "type": "object"
         },
@@ -91,6 +89,7 @@
             "enum": [
                 "input",
                 "extra",
+                "pattern",
                 "input-pattern",
                 "extra-pattern"
             ],
@@ -1225,6 +1224,7 @@
                             "$ref": "#/definitions/OutputTopicTypes"
                         }
                     ],
+                    "default": "output",
                     "description": "Topic type"
                 },
                 "valueSchema": {
@@ -1233,9 +1233,6 @@
                     "type": "string"
                 }
             },
-            "required": [
-                "type"
-            ],
             "title": "TopicConfig",
             "type": "object"
         }

kpops/components/base_components/models/from_section.py

@@ -16,6 +16,7 @@ class InputTopicTypes(str, Enum):
 
     INPUT = "input"
     EXTRA = "extra"
+    PATTERN = "pattern"
     INPUT_PATTERN = "input-pattern"
     EXTRA_PATTERN = "extra-pattern"
 
@@ -25,11 +26,13 @@ class FromTopic(BaseModel):
 
     :param type: Topic type
     :type type: InputTopicTypes
-    :param role: Custom identifier belonging to a topic, provide only if `type` is `extra` or `extra-pattern`
+    :param role: Custom identifier belonging to a topic, provide only if `type` is `extra`, `pattern` or `extra-pattern`
     :type role: str | None
     """
 
-    type: InputTopicTypes = Field(..., description=describe_attr("type", __doc__))
+    type: InputTopicTypes = Field(
+        default=InputTopicTypes.INPUT, description=describe_attr("type", __doc__)
+    )
     role: str | None = Field(default=None, description=describe_attr("role", __doc__))
 
     class Config(DescConfig):
@@ -41,6 +44,7 @@ def extra_topic_role(cls, values: dict) -> dict:
         """Ensure that cls.role is used correctly"""
         is_extra_topic = values["type"] in (
             InputTopicTypes.EXTRA,
+            InputTopicTypes.PATTERN,
             InputTopicTypes.EXTRA_PATTERN,
         )
         if is_extra_topic and not values.get("role"):

kpops/components/base_components/models/to_section.py

@@ -35,7 +35,9 @@ class TopicConfig(BaseModel):
     :type role: str | None
     """
 
-    type: OutputTopicTypes = Field(..., description="Topic type")
+    type: OutputTopicTypes = Field(
+        default=OutputTopicTypes.OUTPUT, description="Topic type"
+    )
     key_schema: str | None = Field(
         default=None, alias="keySchema", description="Key schema class name"
     )

kpops/components/base_components/pipeline_component.py

@@ -54,7 +54,7 @@ class PipelineComponent(BaseDefaultsComponent):
         description=describe_object(__doc__),
         exclude=True,
     )
-    name: str = Field(default=..., description="Component name")
+    name: str = Field(default=..., description=describe_attr("name", __doc__))
     from_: FromSection | None = Field(
         default=None,
         alias="from",

tests/cli/snapshots/snap_test_schema_generation.py

@@ -98,7 +98,7 @@
             "description": "Input topic",
             "properties": {
                 "role": {
-                    "description": "Custom identifier belonging to a topic, provide only if `type` is `extra` or `extra-pattern`",
+                    "description": "Custom identifier belonging to a topic, provide only if `type` is `extra`, `pattern` or `extra-pattern`",
                     "title": "Role",
                     "type": "string"
                 },
@@ -108,12 +108,10 @@
                             "$ref": "#/definitions/InputTopicTypes"
                         }
                     ],
+                    "default": "input",
                     "description": "Topic type"
                 }
             },
-            "required": [
-                "type"
-            ],
             "title": "FromTopic",
             "type": "object"
         },
@@ -122,6 +120,7 @@
             "enum": [
                 "input",
                 "extra",
+                "pattern",
                 "input-pattern",
                 "extra-pattern"
             ],
@@ -379,6 +378,7 @@
                             "$ref": "#/definitions/OutputTopicTypes"
                         }
                     ],
+                    "default": "output",
                     "description": "Topic type"
                 },
                 "valueSchema": {
@@ -387,9 +387,6 @@
                     "type": "string"
                 }
             },
-            "required": [
-                "type"
-            ],
             "title": "TopicConfig",
             "type": "object"
         }