infrahub-server 1.2.0b1__py3-none-any.whl → 1.2.1__py3-none-any.whl

infrahub/core/schema/definitions/core/propose_change.py

@@ -3,86 +3,95 @@ from infrahub.core.constants import (
     InfrahubKind,
     RelationshipDeleteBehavior,
 )
+from infrahub.core.constants import RelationshipCardinality as Cardinality
+from infrahub.core.constants import RelationshipKind as RelKind
 from infrahub.proposed_change.constants import ProposedChangeState
 
-core_proposed_change = {
-    "name": "ProposedChange",
-    "namespace": "Core",
-    "description": "Metadata related to a proposed change",
-    "include_in_menu": False,
-    "icon": "mdi:file-replace-outline",
-    "label": "Proposed Change",
-    "default_filter": "name__value",
-    "display_labels": ["name__value"],
-    "generate_profile": False,
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "inherit_from": [InfrahubKind.TASKTARGET],
-    "documentation": "/topics/proposed-change",
-    "attributes": [
-        {"name": "name", "kind": "Text", "optional": False},
-        {"name": "description", "kind": "TextArea", "optional": True},
-        {"name": "source_branch", "kind": "Text", "optional": False},
-        {"name": "destination_branch", "kind": "Text", "optional": False},
-        {
-            "name": "state",
-            "kind": "Text",
-            "enum": ProposedChangeState.available_types(),
-            "default_value": ProposedChangeState.OPEN.value,
-            "optional": True,
-        },
+from ...attribute_schema import AttributeSchema as Attr
+from ...node_schema import NodeSchema
+from ...relationship_schema import (
+    RelationshipSchema as Rel,
+)
+
+core_proposed_change = NodeSchema(
+    name="ProposedChange",
+    namespace="Core",
+    description="Metadata related to a proposed change",
+    include_in_menu=False,
+    icon="mdi:file-replace-outline",
+    label="Proposed Change",
+    default_filter="name__value",
+    display_labels=["name__value"],
+    generate_profile=False,
+    branch=BranchSupportType.AGNOSTIC,
+    inherit_from=[InfrahubKind.TASKTARGET],
+    documentation="/topics/proposed-change",
+    attributes=[
+        Attr(name="name", kind="Text", optional=False),
+        Attr(name="description", kind="TextArea", optional=True),
+        Attr(name="source_branch", kind="Text", optional=False),
+        Attr(name="destination_branch", kind="Text", optional=False),
+        Attr(
+            name="state",
+            kind="Text",
+            enum=ProposedChangeState.available_types(),
+            default_value=ProposedChangeState.OPEN.value,
+            optional=True,
+        ),
     ],
-    "relationships": [
-        {
-            "name": "approved_by",
-            "peer": InfrahubKind.GENERICACCOUNT,
-            "optional": True,
-            "cardinality": "many",
-            "kind": "Attribute",
-            "branch": BranchSupportType.AGNOSTIC.value,
-            "identifier": "coreaccount__proposedchange_approved_by",
-        },
-        {
-            "name": "reviewers",
-            "peer": InfrahubKind.GENERICACCOUNT,
-            "optional": True,
-            "kind": "Attribute",
-            "cardinality": "many",
-            "branch": BranchSupportType.AGNOSTIC.value,
-            "identifier": "coreaccount__proposedchange_reviewed_by",
-        },
-        {
-            "name": "created_by",
-            "peer": InfrahubKind.GENERICACCOUNT,
-            "optional": True,
-            "cardinality": "one",
-            "branch": BranchSupportType.AGNOSTIC.value,
-            "identifier": "coreaccount__proposedchange_created_by",
-        },
-        {
-            "name": "comments",
-            "peer": InfrahubKind.CHANGECOMMENT,
-            "kind": "Component",
-            "optional": True,
-            "cardinality": "many",
-            "on_delete": RelationshipDeleteBehavior.CASCADE,
-        },
-        {
-            "name": "threads",
-            "peer": InfrahubKind.THREAD,
-            "identifier": "proposedchange__thread",
-            "kind": "Component",
-            "optional": True,
-            "cardinality": "many",
-            "on_delete": RelationshipDeleteBehavior.CASCADE,
-        },
-        {
-            "name": "validations",
-            "peer": InfrahubKind.VALIDATOR,
-            "kind": "Component",
-            "identifier": "proposed_change__validator",
-            "optional": True,
-            "cardinality": "many",
-            "on_delete": RelationshipDeleteBehavior.CASCADE,
-        },
+    relationships=[
+        Rel(
+            name="approved_by",
+            peer=InfrahubKind.GENERICACCOUNT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+            branch=BranchSupportType.AGNOSTIC,
+            identifier="coreaccount__proposedchange_approved_by",
+        ),
+        Rel(
+            name="reviewers",
+            peer=InfrahubKind.GENERICACCOUNT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+            branch=BranchSupportType.AGNOSTIC,
+            identifier="coreaccount__proposedchange_reviewed_by",
+        ),
+        Rel(
+            name="created_by",
+            peer=InfrahubKind.GENERICACCOUNT,
+            optional=True,
+            cardinality=Cardinality.ONE,
+            kind=RelKind.ATTRIBUTE,
+            branch=BranchSupportType.AGNOSTIC,
+            identifier="coreaccount__proposedchange_created_by",
+        ),
+        Rel(
+            name="comments",
+            peer=InfrahubKind.CHANGECOMMENT,
+            kind=RelKind.COMPONENT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+        ),
+        Rel(
+            name="threads",
+            peer=InfrahubKind.THREAD,
+            identifier="proposedchange__thread",
+            kind=RelKind.COMPONENT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+        ),
+        Rel(
+            name="validations",
+            peer=InfrahubKind.VALIDATOR,
+            kind=RelKind.COMPONENT,
+            identifier="proposed_change__validator",
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+        ),
     ],
-}
+)

infrahub/core/schema/definitions/core/propose_change_comment.py

@@ -3,186 +3,191 @@ from infrahub.core.constants import (
     InfrahubKind,
     RelationshipDeleteBehavior,
 )
+from infrahub.core.constants import RelationshipCardinality as Cardinality
+from infrahub.core.constants import RelationshipKind as RelKind
 
-core_propose_change_comment = {
-    "name": "Comment",
-    "namespace": "Core",
-    "description": "A comment on a Proposed Change",
-    "label": "Comment",
-    "display_labels": ["text__value"],
-    "order_by": ["created_at__value"],
-    "include_in_menu": False,
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "attributes": [
-        {"name": "text", "kind": "TextArea", "unique": False, "optional": False},
-        {"name": "created_at", "kind": "DateTime", "optional": True},
+from ...attribute_schema import AttributeSchema as Attr
+from ...generic_schema import GenericSchema
+from ...node_schema import NodeSchema
+from ...relationship_schema import (
+    RelationshipSchema as Rel,
+)
+
+core_propose_change_comment = GenericSchema(
+    name="Comment",
+    namespace="Core",
+    description="A comment on a Proposed Change",
+    label="Comment",
+    display_labels=["text__value"],
+    order_by=["created_at__value"],
+    include_in_menu=False,
+    branch=BranchSupportType.AGNOSTIC,
+    attributes=[
+        Attr(name="text", kind="TextArea", unique=False, optional=False),
+        Attr(name="created_at", kind="DateTime", optional=True),
     ],
-    "relationships": [
-        {
-            "name": "created_by",
-            "peer": InfrahubKind.GENERICACCOUNT,
-            "optional": True,
-            "branch": BranchSupportType.AGNOSTIC.value,
-            "cardinality": "one",
-            "identifier": "comment__account",
-        },
+    relationships=[
+        Rel(
+            name="created_by",
+            peer=InfrahubKind.GENERICACCOUNT,
+            optional=True,
+            branch=BranchSupportType.AGNOSTIC,
+            cardinality=Cardinality.ONE,
+            identifier="comment__account",
+        ),
     ],
-}
+)
 
-core_thread = {
-    "name": "Thread",
-    "namespace": "Core",
-    "description": "A thread on a Proposed Change",
-    "label": "Thread",
-    "order_by": ["created_at__value"],
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "include_in_menu": False,
-    "attributes": [
-        {"name": "label", "kind": "Text", "optional": True},
-        {"name": "resolved", "kind": "Boolean", "default_value": False},
-        {"name": "created_at", "kind": "DateTime", "optional": True},
+core_thread = GenericSchema(
+    name="Thread",
+    namespace="Core",
+    description="A thread on a Proposed Change",
+    label="Thread",
+    order_by=["created_at__value"],
+    branch=BranchSupportType.AGNOSTIC,
+    include_in_menu=False,
+    attributes=[
+        Attr(name="label", kind="Text", optional=True),
+        Attr(name="resolved", kind="Boolean", default_value=False),
+        Attr(name="created_at", kind="DateTime", optional=True),
     ],
-    "relationships": [
-        {
-            "name": "change",
-            "peer": InfrahubKind.PROPOSEDCHANGE,
-            "identifier": "proposedchange__thread",
-            "kind": "Parent",
-            "optional": False,
-            "cardinality": "one",
-        },
-        {
-            "name": "comments",
-            "peer": InfrahubKind.THREADCOMMENT,
-            "identifier": "thread__threadcomment",
-            "kind": "Component",
-            "optional": True,
-            "cardinality": "many",
-            "on_delete": RelationshipDeleteBehavior.CASCADE,
-        },
-        {
-            "name": "created_by",
-            "peer": InfrahubKind.GENERICACCOUNT,
-            "identifier": "thread__account",
-            "optional": True,
-            "branch": BranchSupportType.AGNOSTIC.value,
-            "cardinality": "one",
-        },
+    relationships=[
+        Rel(
+            name="change",
+            peer=InfrahubKind.PROPOSEDCHANGE,
+            identifier="proposedchange__thread",
+            kind=RelKind.PARENT,
+            optional=False,
+            cardinality=Cardinality.ONE,
+        ),
+        Rel(
+            name="comments",
+            peer=InfrahubKind.THREADCOMMENT,
+            identifier="thread__threadcomment",
+            kind=RelKind.COMPONENT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+        ),
+        Rel(
+            name="created_by",
+            peer=InfrahubKind.GENERICACCOUNT,
+            identifier="thread__account",
+            optional=True,
+            branch=BranchSupportType.AGNOSTIC,
+            cardinality=Cardinality.ONE,
+        ),
     ],
-}
+)
 
-core_change_thread = {
-    "name": "ChangeThread",
-    "namespace": "Core",
-    "description": "A thread on proposed change",
-    "include_in_menu": False,
-    "label": "Change Thread",
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "inherit_from": [InfrahubKind.THREAD],
-    "generate_profile": False,
-    "attributes": [],
-    "relationships": [],
-}
+core_change_thread = NodeSchema(
+    name="ChangeThread",
+    namespace="Core",
+    description="A thread on proposed change",
+    include_in_menu=False,
+    label="Change Thread",
+    branch=BranchSupportType.AGNOSTIC,
+    inherit_from=[InfrahubKind.THREAD],
+    generate_profile=False,
+)
 
-core_file_thread = {
-    "name": "FileThread",
-    "namespace": "Core",
-    "description": "A thread related to a file on a proposed change",
-    "include_in_menu": False,
-    "label": "Thread - File",
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "inherit_from": [InfrahubKind.THREAD],
-    "generate_profile": False,
-    "attributes": [
-        {"name": "file", "kind": "Text", "optional": True},
-        {"name": "commit", "kind": "Text", "optional": True},
-        {"name": "line_number", "kind": "Number", "optional": True},
+core_file_thread = NodeSchema(
+    name="FileThread",
+    namespace="Core",
+    description="A thread related to a file on a proposed change",
+    include_in_menu=False,
+    label="Thread - File",
+    branch=BranchSupportType.AGNOSTIC,
+    inherit_from=[InfrahubKind.THREAD],
+    generate_profile=False,
+    attributes=[
+        Attr(name="file", kind="Text", optional=True),
+        Attr(name="commit", kind="Text", optional=True),
+        Attr(name="line_number", kind="Number", optional=True),
     ],
-    "relationships": [
-        {
-            "name": "repository",
-            "peer": InfrahubKind.REPOSITORY,
-            "optional": False,
-            "cardinality": "one",
-            "branch": BranchSupportType.AGNOSTIC.value,
-        },
+    relationships=[
+        Rel(
+            name="repository",
+            peer=InfrahubKind.REPOSITORY,
+            optional=False,
+            cardinality=Cardinality.ONE,
+            branch=BranchSupportType.AGNOSTIC,
+        ),
     ],
-}
+)
 
-core_artifact_thread = {
-    "name": "ArtifactThread",
-    "namespace": "Core",
-    "description": "A thread related to an artifact on a proposed change",
-    "include_in_menu": False,
-    "label": "Thread - Artifact",
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "inherit_from": [InfrahubKind.THREAD],
-    "generate_profile": False,
-    "attributes": [
-        {"name": "artifact_id", "kind": "Text", "optional": True},
-        {"name": "storage_id", "kind": "Text", "optional": True},
-        {"name": "line_number", "kind": "Number", "optional": True},
+core_artifact_thread = NodeSchema(
+    name="ArtifactThread",
+    namespace="Core",
+    description="A thread related to an artifact on a proposed change",
+    include_in_menu=False,
+    label="Thread - Artifact",
+    branch=BranchSupportType.AGNOSTIC,
+    inherit_from=[InfrahubKind.THREAD],
+    generate_profile=False,
+    attributes=[
+        Attr(name="artifact_id", kind="Text", optional=True),
+        Attr(name="storage_id", kind="Text", optional=True),
+        Attr(name="line_number", kind="Number", optional=True),
     ],
-    "relationships": [],
-}
+)
 
-core_object_thread = {
-    "name": "ObjectThread",
-    "namespace": "Core",
-    "description": "A thread related to an object on a proposed change",
-    "include_in_menu": False,
-    "label": "Thread - Object",
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "inherit_from": [InfrahubKind.THREAD],
-    "generate_profile": False,
-    "attributes": [
-        {"name": "object_path", "kind": "Text", "optional": False},
+core_object_thread = NodeSchema(
+    name="ObjectThread",
+    namespace="Core",
+    description="A thread related to an object on a proposed change",
+    include_in_menu=False,
+    label="Thread - Object",
+    branch=BranchSupportType.AGNOSTIC,
+    inherit_from=[InfrahubKind.THREAD],
+    generate_profile=False,
+    attributes=[
+        Attr(name="object_path", kind="Text", optional=False),
     ],
-    "relationships": [],
-}
+)
 
-core_change_comment = {
-    "name": "ChangeComment",
-    "namespace": "Core",
-    "description": "A comment on proposed change",
-    "include_in_menu": False,
-    "label": "Change Comment",
-    "default_filter": "text__value",
-    "display_labels": ["text__value"],
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "inherit_from": [InfrahubKind.COMMENT],
-    "generate_profile": False,
-    "relationships": [
-        {
-            "name": "change",
-            "kind": "Parent",
-            "peer": InfrahubKind.PROPOSEDCHANGE,
-            "cardinality": "one",
-            "optional": False,
-        },
+core_change_comment = NodeSchema(
+    name="ChangeComment",
+    namespace="Core",
+    description="A comment on proposed change",
+    include_in_menu=False,
+    label="Change Comment",
+    default_filter="text__value",
+    display_labels=["text__value"],
+    branch=BranchSupportType.AGNOSTIC,
+    inherit_from=[InfrahubKind.COMMENT],
+    generate_profile=False,
+    relationships=[
+        Rel(
+            name="change",
+            kind=RelKind.PARENT,
+            peer=InfrahubKind.PROPOSEDCHANGE,
+            cardinality=Cardinality.ONE,
+            optional=False,
+        ),
     ],
-}
+)
 
-core_thread_comment = {
-    "name": "ThreadComment",
-    "namespace": "Core",
-    "description": "A comment on thread within a Proposed Change",
-    "include_in_menu": False,
-    "label": "Thread Comment",
-    "default_filter": "text__value",
-    "display_labels": ["text__value"],
-    "branch": BranchSupportType.AGNOSTIC.value,
-    "inherit_from": [InfrahubKind.COMMENT],
-    "generate_profile": False,
-    "attributes": [],
-    "relationships": [
-        {
-            "name": "thread",
-            "peer": InfrahubKind.THREAD,
-            "kind": "Parent",
-            "identifier": "thread__threadcomment",
-            "cardinality": "one",
-            "optional": False,
-        },
+core_thread_comment = NodeSchema(
+    name="ThreadComment",
+    namespace="Core",
+    description="A comment on thread within a Proposed Change",
+    include_in_menu=False,
+    label="Thread Comment",
+    default_filter="text__value",
+    display_labels=["text__value"],
+    branch=BranchSupportType.AGNOSTIC,
+    inherit_from=[InfrahubKind.COMMENT],
+    generate_profile=False,
+    attributes=[],
+    relationships=[
+        Rel(
+            name="thread",
+            peer=InfrahubKind.THREAD,
+            kind=RelKind.PARENT,
+            identifier="thread__threadcomment",
+            cardinality=Cardinality.ONE,
+            optional=False,
+        ),
     ],
-}
+)