metadata.specification package

Subpackages

• metadata.specification.activity package
  • Subpackages
    • metadata.specification.activity.classifiers package
      • Submodules
      • metadata.specification.activity.classifiers.action module
      • metadata.specification.activity.classifiers.control module
      • metadata.specification.activity.classifiers.event module
      • metadata.specification.activity.classifiers.object module
      • metadata.specification.activity.classifiers.swimlane module
      • Module contents
  • Submodules
  • metadata.specification.activity.relations module
    • ControlFlow
      • ControlFlow.condition
      • ControlFlow.guard
      • ControlFlow.is_directed
      • ControlFlow.model_config
      • ControlFlow.type
      • ControlFlow.weight
    • ControlFlowCondition
      • ControlFlowCondition.aggregator
      • ControlFlowCondition.isElse
      • ControlFlowCondition.model_config
      • ControlFlowCondition.operator
      • ControlFlowCondition.set_target_class_name()
      • ControlFlowCondition.target_attribute
      • ControlFlowCondition.target_attribute_type
      • ControlFlowCondition.target_class
      • ControlFlowCondition.target_class_name
      • ControlFlowCondition.threshold
      • ControlFlowCondition.validate_condition()
    • ObjectFlow
      • ObjectFlow.cls
      • ObjectFlow.guard
      • ObjectFlow.is_directed
      • ObjectFlow.model_config
      • ObjectFlow.type
      • ObjectFlow.weight
  • Module contents
• metadata.specification.applications package
  • Submodules
  • metadata.specification.applications.classifiers module
  • Module contents
• metadata.specification.base package
  • Submodules
  • metadata.specification.base.relations module
    • PositionHandlers
      • PositionHandlers.model_config
      • PositionHandlers.x
      • PositionHandlers.y
    • RelationBase
      • RelationBase.model_config
      • RelationBase.position_handlers
  • Module contents
    • RelationBase
      • RelationBase.model_config
      • RelationBase.position_handlers
• metadata.specification.classes package
  • Submodules
  • metadata.specification.classes.classifiers module
    • Application
      • Application.model_config
      • Application.type
    • ApplicationClassifiers
      • ApplicationClassifiers.attributes
      • ApplicationClassifiers.id
      • ApplicationClassifiers.model_config
    • ApplicationShared
      • ApplicationShared.categories
      • ApplicationShared.classifiers
      • ApplicationShared.model_config
    • Category
      • Category.model_config
      • Category.name
    • Class
      • Class.abstract
      • Class.attributes
      • Class.leaf
      • Class.methods
      • Class.model_config
      • Class.type
    • Enum
      • Enum.literals
      • Enum.model_config
      • Enum.type
    • Interface
      • Interface.model_config
      • Interface.type
    • Page
      • Page.create
      • Page.data_paths
      • Page.model_config
      • Page.page_type
      • Page.query
      • Page.type
    • Section
      • Section.classes
      • Section.content
      • Section.linked_page
      • Section.model_config
      • Section.sorting
      • Section.type
    • Signal
      • Signal.model_config
      • Signal.type
  • metadata.specification.classes.relations module
  • Module contents
• metadata.specification.component package
  • Submodules
  • metadata.specification.component.classifiers module
    • Component
      • Component.model_config
      • Component.type
    • Container
      • Container.model_config
      • Container.type
    • Internal
      • Internal.model_config
      • Internal.name
      • Internal.set_type_name()
      • Internal.type
      • Internal.typeName
    • InternalsElement
      • InternalsElement.internals
      • InternalsElement.model_config
    • System
      • System.model_config
      • System.type
  • metadata.specification.component.relations module
    • ComponentRelation
    • Interface
      • Interface.fill_interface_names()
      • Interface.model_config
      • Interface.provided
      • Interface.provided_name
      • Interface.required
      • Interface.required_name
      • Interface.type
  • Module contents
    • ComponentRelation
• metadata.specification.kernel package
  • Module contents
    • Attribute
      • Attribute.body
      • Attribute.derived
      • Attribute.description
      • Attribute.enum
      • Attribute.model_config
      • Attribute.name
      • Attribute.type
    • Multiplicity
      • Multiplicity.is_ordered
      • Multiplicity.is_unique
      • Multiplicity.lower
      • Multiplicity.model_config
      • Multiplicity.upper
    • NamedElement
      • NamedElement.model_config
      • NamedElement.name
    • NamespacedElement
      • NamespacedElement.model_config
      • NamespacedElement.namespace
    • Operation
      • Operation.body
      • Operation.description
      • Operation.model_config
      • Operation.name
      • Operation.type
    • RelationLabels
      • RelationLabels.model_config
      • RelationLabels.source
      • RelationLabels.target
    • RelationMultiplicity
      • RelationMultiplicity.model_config
      • RelationMultiplicity.source
      • RelationMultiplicity.target
• metadata.specification.usecase package
  • Submodules
  • metadata.specification.usecase.classifiers module
  • metadata.specification.usecase.relations module
    • UsecaseRelation
      • UsecaseRelation.model_config
      • UsecaseRelation.type
  • Module contents
    • UsecaseRelation
      • UsecaseRelation.model_config
      • UsecaseRelation.position_handlers
      • UsecaseRelation.type

Module contents

class metadata.specification.ClassifierSchema(**data)

Bases: ClassifierSchema

Parameters:

• data (Annotated[Annotated[SwimLane | SwimLaneGroup, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | Action | Annotated[Decision | Final | Fork | Initial | Join | Merge, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | Object | Event | Application | Page | Section | Class | Enum | Signal | Interface | Actor | Usecase | SystemBoundary | System | Container | Component, FieldInfo(annotation=NoneType, required=True, discriminator='type')])

• system_id (UUID | None)

• system_name (str | None)

• id (UUID | None)

data: Annotated[Union[Annotated[Union[SwimLane, SwimLaneGroup]], Action, Annotated[Union[Decision, Final, Fork, Initial, Join, Merge]], Object, Event, Application, Page, Section, Class, Enum, Signal, Interface, Actor, Usecase, SystemBoundary, System, Container, Component]]

id: Optional[UUID]

model_config: ClassVar[ConfigDict] = {'from_attributes': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

system_id: Optional[UUID]

system_name: Optional[str]

class metadata.specification.RelationSchema(**data)

Bases: RelationSchema

Parameters:

• id (UUID | None)

• data (AnyObject)

• source_id (UUID)

• target_id (UUID)

data: AnyObject

id: Optional[UUID]

model_config: ClassVar[ConfigDict] = {'from_attributes': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

source: UUID

target: UUID