metadata.api.schemas package

Submodules

metadata.api.schemas.interface module

class metadata.api.schemas.interface.CreateInterface(**data)

Bases: CreateInterface

Parameters:

  • name (str)

  • description (str)

  • system_id (UUID)

  • actor_id (UUID | None)

  • data (AnyObject)

actor: Optional[UUID]
data: AnyObject
description: str
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
system: UUID
class metadata.api.schemas.interface.DeleteInterface(**data)

Bases: DeleteInterface

Parameters:

id (UUID | None)

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

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

class metadata.api.schemas.interface.ExportInterface(**data)

Bases: ExportInterface

Parameters:

  • id (UUID | None)

  • system_id (UUID)

  • name (str)

  • description (str)

  • actor_id (UUID | None)

  • data (AnyObject)

actor: Optional[UUID]
data: AnyObject
description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
system: UUID
class metadata.api.schemas.interface.ReadInterface(**data)

Bases: ReadInterface

Parameters:

  • id (UUID | None)

  • name (str)

  • description (str)

  • system_id (UUID)

  • actor_id (UUID | None)

  • data (AnyObject)

actor: Optional[UUID]
data: AnyObject
description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
system: UUID
class metadata.api.schemas.interface.UpdateInterface(**data)

Bases: UpdateInterface

Parameters:

  • id (UUID | None)

  • name (str)

  • description (str)

  • system_id (UUID)

  • actor_id (UUID | None)

  • data (AnyObject)

actor: Optional[UUID]
data: AnyObject
description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
system: UUID

metadata.api.schemas.meta module

class metadata.api.schemas.meta.ExportClassifier(**data)

Bases: ExportClassifier

Parameters:

  • id (UUID | None)

  • project_id (UUID | None)

  • system_id (UUID | None)

  • original_system_id (UUID | None)

  • data (AnyObject)

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].

original_system_id: Optional[UUID]
project: Optional[UUID]
system: Optional[UUID]
class metadata.api.schemas.meta.ExportRelation(**data)

Bases: ExportRelation

Parameters:

  • id (UUID | None)

  • data (AnyObject)

  • system_id (UUID)

  • 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
system: UUID
target: UUID
class metadata.api.schemas.meta.ImportClassifier(**data)

Bases: Schema

Parameters:

  • id (str)

  • project (str | None)

  • system (str)

  • original_system_id (str | None)

  • data (dict)

data: dict
id: str
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

original_system_id: Optional[str]
project: Optional[str]
system: str
class metadata.api.schemas.meta.ImportRelation(**data)

Bases: Schema

Parameters:

  • id (str)

  • system (str)

  • source (str)

  • target (str)

  • data (dict)

data: dict
id: str
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

source: str
system: str
target: str
class metadata.api.schemas.meta.MetaClassifiersSchema(**data)

Bases: Schema

Parameters:

classifiers (List[ClassifierSchema])

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

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

class metadata.api.schemas.meta.MetaRelationsSchema(**data)

Bases: Schema

Parameters:

relations (List[RelationSchema])

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

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

relations: List[RelationSchema]
class metadata.api.schemas.meta.MetaSchema(**data)

Bases: Schema

Parameters:
classifiers: List[ClassifierSchema]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

relations: List[RelationSchema]

metadata.api.schemas.project module

class metadata.api.schemas.project.CreateProject(**data)

Bases: CreateProject

Parameters:

  • name (str)

  • description (str)

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

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

name: str
class metadata.api.schemas.project.DeleteProject(**data)

Bases: DeleteProject

Parameters:

id (UUID | None)

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

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

class metadata.api.schemas.project.ExportProject(**data)

Bases: ExportProject

Parameters:

  • systems (List[ExportSystem])

  • id (UUID | None)

  • name (str)

  • description (str)

description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
systems: List[ExportSystem]
class metadata.api.schemas.project.ImportProject(**data)

Bases: Schema

Parameters:

  • id (str)

  • name (str)

  • description (str | None)

  • systems (List[ImportSystem])

description: Optional[str]
id: str
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
systems: List[ImportSystem]
class metadata.api.schemas.project.ReadProject(**data)

Bases: ReadProject

Parameters:

  • id (UUID | None)

  • name (str)

  • description (str)

description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
class metadata.api.schemas.project.UpdateProject(**data)

Bases: UpdateProject

Parameters:

  • id (UUID | None)

  • name (str)

  • description (str)

description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str

metadata.api.schemas.release module

class metadata.api.schemas.release.CreateRelease(**data)

Bases: Schema

Parameters:

  • project (str)

  • name (str)

  • release_notes (List[str])

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

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

name: str
project: str
release_notes: List[str]
class metadata.api.schemas.release.ExportRelease(**data)

Bases: ExportRelease

Parameters:

  • project_id (UUID)

  • project_data (AnyObject)

  • release_notes (AnyObject)

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

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

project: UUID
project_data: AnyObject
release_notes: AnyObject
class metadata.api.schemas.release.ImportRelease(**data)

Bases: Schema

Parameters:

  • project (str)

  • name (str)

  • project_data (ImportProject)

  • release_notes (List[str] | None)

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

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

name: str
project: str
project_data: ImportProject
release_notes: Optional[List[str]]
class metadata.api.schemas.release.ImportReleaseSystem(**data)

Bases: Schema

Parameters:

  • project (str)

  • name (str)

  • systems (List[ImportSingleSystem])

  • release_notes (List[str] | None)

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

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

name: str
project: str
release_notes: Optional[List[str]]
systems: List[ImportSingleSystem]
class metadata.api.schemas.release.ReadRelease(**data)

Bases: ReadRelease

Parameters:

  • id (UUID | None)

  • name (str)

  • created_at (datetime)

  • release_notes (AnyObject)

created_at: datetime
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
release_notes: AnyObject

metadata.api.schemas.system module

class metadata.api.schemas.system.CreateSystem(**data)

Bases: CreateSystem

Parameters:

  • project (str)

  • name (str)

  • description (str)

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

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

name: str
project: str
class metadata.api.schemas.system.ExportSingleSystem(**data)

Bases: ExportSystem

Parameters:
imported_classifiers: List[ExportClassifier]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

static resolve_imported_classifiers(obj)
class metadata.api.schemas.system.ExportSystem(**data)

Bases: ExportSystem

Parameters:
classifiers: List[ExportClassifier]
description: str
diagrams: List[ExportDiagram]
id: Optional[UUID]
interfaces: List[ExportInterface]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
project: UUID
relations: List[ExportRelation]
class metadata.api.schemas.system.FlatDiagram(**data)

Bases: Schema

Parameters:

  • id (UUID)

  • name (str)

  • description (str | None)

description: Optional[str]
id: UUID
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
class metadata.api.schemas.system.ImportSingleSystem(**data)

Bases: ImportSystem

Parameters:
imported_classifiers: List[ImportClassifier]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

class metadata.api.schemas.system.ImportSystem(**data)

Bases: Schema

Parameters:
classifiers: List[ImportClassifier]
description: Optional[str]
diagrams: List[ImportDiagram]
id: str
interfaces: List[ImportInterface]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
project: str
relations: List[ImportRelation]
class metadata.api.schemas.system.ReadSystem(**data)

Bases: ReadSystem

Parameters:

  • diagrams_by_type (SystemDiagrams | None)

  • id (UUID | None)

  • name (str)

  • description (str)

  • project_id (UUID)

description: str
diagrams_by_type: Optional[SystemDiagrams]
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
project: UUID
class metadata.api.schemas.system.SystemDiagrams(**data)

Bases: Schema

Parameters:
activity: List[FlatDiagram]
classes: List[FlatDiagram]
component: List[FlatDiagram]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

usecase: List[FlatDiagram]
class metadata.api.schemas.system.UpdateSystem(**data)

Bases: UpdateSystem

Parameters:

  • name (str)

  • description (str)

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

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

name: str

Module contents

class metadata.api.schemas.CreateInterface(**data)

Bases: CreateInterface

Parameters:

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

  • system_id (UUID)

  • actor_id (UUID | None)

  • data (AnyObject)

actor: Optional[UUID]
data: AnyObject
description: str
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
system: UUID
class metadata.api.schemas.CreateProject(**data)

Bases: CreateProject

Parameters:

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

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

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

name: str
class metadata.api.schemas.CreateRelease(**data)

Bases: Schema

Parameters:

  • project (str)

  • name (str)

  • release_notes (List[str])

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

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

name: str
project: str
release_notes: List[str]
class metadata.api.schemas.CreateSystem(**data)

Bases: CreateSystem

Parameters:

  • project (str)

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

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

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

name: str
project: str
class metadata.api.schemas.ExportClassifier(**data)

Bases: ExportClassifier

Parameters:

  • id (UUID | None)

  • project_id (UUID | None)

  • system_id (UUID | None)

  • original_system_id (UUID | None)

  • data (AnyObject)

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].

original_system_id: Optional[UUID]
project: Optional[UUID]
system: Optional[UUID]
class metadata.api.schemas.ExportProject(**data)

Bases: ExportProject

Parameters:

  • systems (List[ExportSystem])

  • id (UUID | None)

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
systems: List[ExportSystem]
class metadata.api.schemas.ExportRelation(**data)

Bases: ExportRelation

Parameters:

  • id (UUID | None)

  • data (AnyObject)

  • system_id (UUID)

  • 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
system: UUID
target: UUID
class metadata.api.schemas.ExportRelease(**data)

Bases: ExportRelease

Parameters:

  • project_id (UUID)

  • project_data (AnyObject)

  • release_notes (AnyObject)

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

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

project: UUID
project_data: AnyObject
release_notes: AnyObject
class metadata.api.schemas.ExportSingleSystem(**data)

Bases: ExportSystem

Parameters:
classifiers: List[ExportClassifier]
diagrams: List[ExportDiagram]
imported_classifiers: List[ExportClassifier]
interfaces: List[ExportInterface]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

relations: List[ExportRelation]
static resolve_imported_classifiers(obj)
class metadata.api.schemas.ExportSystem(**data)

Bases: ExportSystem

Parameters:
classifiers: List[ExportClassifier]
description: str
diagrams: List[ExportDiagram]
id: Optional[UUID]
interfaces: List[ExportInterface]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
project: UUID
relations: List[ExportRelation]
class metadata.api.schemas.ImportProject(**data)

Bases: Schema

Parameters:

  • id (str)

  • name (str)

  • description (str | None)

  • systems (List[ImportSystem])

description: Optional[str]
id: str
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
systems: List[ImportSystem]
class metadata.api.schemas.ImportRelease(**data)

Bases: Schema

Parameters:

  • project (str)

  • name (str)

  • project_data (ImportProject)

  • release_notes (List[str] | None)

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

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

name: str
project: str
project_data: ImportProject
release_notes: Optional[List[str]]
class metadata.api.schemas.ImportReleaseSystem(**data)

Bases: Schema

Parameters:

  • project (str)

  • name (str)

  • systems (List[ImportSingleSystem])

  • release_notes (List[str] | None)

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

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

name: str
project: str
release_notes: Optional[List[str]]
systems: List[ImportSingleSystem]
class metadata.api.schemas.ImportSingleSystem(**data)

Bases: ImportSystem

Parameters:
classifiers: List[ImportClassifier]
description: Optional[str]
diagrams: List[ImportDiagram]
id: str
imported_classifiers: List[ImportClassifier]
interfaces: List[ImportInterface]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
project: str
relations: List[ImportRelation]
class metadata.api.schemas.MetaClassifiersSchema(**data)

Bases: Schema

Parameters:

classifiers (List[ClassifierSchema])

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

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

class metadata.api.schemas.MetaRelationsSchema(**data)

Bases: Schema

Parameters:

relations (List[RelationSchema])

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

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

relations: List[RelationSchema]
class metadata.api.schemas.MetaSchema(**data)

Bases: Schema

Parameters:
classifiers: List[ClassifierSchema]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

relations: List[RelationSchema]
class metadata.api.schemas.ReadInterface(**data)

Bases: ReadInterface

Parameters:

  • id (UUID | None)

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

  • system_id (UUID)

  • actor_id (UUID | None)

  • data (AnyObject)

actor: Optional[UUID]
data: AnyObject
description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
system: UUID
class metadata.api.schemas.ReadProject(**data)

Bases: ReadProject

Parameters:

  • id (UUID | None)

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
class metadata.api.schemas.ReadRelease(**data)

Bases: ReadRelease

Parameters:

  • id (UUID | None)

  • name (Annotated[str, MaxLen(max_length=255)])

  • created_at (datetime)

  • release_notes (AnyObject)

created_at: datetime
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
release_notes: AnyObject
class metadata.api.schemas.ReadSystem(**data)

Bases: ReadSystem

Parameters:

  • diagrams_by_type (SystemDiagrams | None)

  • id (UUID | None)

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

  • project_id (UUID)

description: str
diagrams_by_type: Optional[SystemDiagrams]
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
project: UUID
class metadata.api.schemas.UpdateInterface(**data)

Bases: UpdateInterface

Parameters:

  • id (UUID | None)

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

  • system_id (UUID)

  • actor_id (UUID | None)

  • data (AnyObject)

actor: Optional[UUID]
data: AnyObject
description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
system: UUID
class metadata.api.schemas.UpdateProject(**data)

Bases: UpdateProject

Parameters:

  • id (UUID | None)

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

description: str
id: Optional[UUID]
model_config: ClassVar[ConfigDict] = {'from_attributes': True}

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

name: str
class metadata.api.schemas.UpdateSystem(**data)

Bases: UpdateSystem

Parameters:

  • name (Annotated[str, MaxLen(max_length=255)])

  • description (str)

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

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

name: str