fmn.api.api_models module

class fmn.api.api_models.Artifact(*, type: ArtifactType, name: str)[source]

Bases: BaseModel

model_config = {'from_attributes': True}

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

name: str
type: ArtifactType
class fmn.api.api_models.ArtifactOptionsGroup(*, label: str, options: list[Option[Artifact]])[source]

Bases: BaseModel

label: str
model_config = {'from_attributes': True}

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

options: list[Option[Artifact]]
class fmn.api.api_models.ArtifactsFollowedTrackingRule(*, name: Literal['artifacts-followed'], params: list[dict[Literal['name', 'type'], str]])[source]

Bases: BaseModel

model_config = {'from_attributes': True}

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

name: Literal['artifacts-followed']
params: list[dict[Literal['name', 'type'], str]]
class fmn.api.api_models.BaseModel[source]

Bases: BaseModel

model_config = {'from_attributes': True}

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

class fmn.api.api_models.Destination(*, protocol: str, address: str)[source]

Bases: BaseModel

address: str
classmethod address_format(v, info: ValidationInfo)[source]
model_config = {'from_attributes': True}

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

protocol: str
class fmn.api.api_models.Filters(*, applications: list[str] = [], excluded_applications: list[str] = [], severities: list[str] = [], topic: str | None = None, my_actions: bool = False)[source]

Bases: BaseModel

applications: list[str]
classmethod convert_from_orm(data)[source]
excluded_applications: list[str]
model_config = {'from_attributes': True}

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

my_actions: bool
severities: list[str]
topic: str | None
class fmn.api.api_models.GenerationRule(*, id: int | None = None, destinations: list[Destination], filters: Filters)[source]

Bases: BaseModel

destinations: list[Destination]
filters: Filters
id: int | None
model_config = {'from_attributes': True}

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

class fmn.api.api_models.ListParamTrackingRule(*, name: Literal['artifacts-owned', 'artifacts-group-owned', 'users-followed'], params: list[str])[source]

Bases: BaseModel

model_config = {'from_attributes': True}

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

name: Literal['artifacts-owned', 'artifacts-group-owned', 'users-followed']
params: list[str]
class fmn.api.api_models.NewRule(*, name: str | None = None, disabled: bool = False, tracking_rule: ListParamTrackingRule | NoParamTrackingRule | ArtifactsFollowedTrackingRule, generation_rules: list[GenerationRule])[source]

Bases: BaseModel

disabled: bool
generation_rules: list[GenerationRule]
model_config = {'from_attributes': True}

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

name: str | None
tracking_rule: Annotated[ListParamTrackingRule | NoParamTrackingRule | ArtifactsFollowedTrackingRule, FieldInfo(annotation=NoneType, required=True, discriminator='name')]
class fmn.api.api_models.NoParamTrackingRule(*, name: Literal['related-events'], params: str | None = None)[source]

Bases: BaseModel

model_config = {'from_attributes': True}

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

name: Literal['related-events']
params: str | None
class fmn.api.api_models.Option(*, label: str, value: T)[source]

Bases: BaseModel, Generic[T]

label: str
model_config = {'from_attributes': True}

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

value: T
class fmn.api.api_models.Rule(*, name: str | None = None, disabled: bool = False, tracking_rule: ListParamTrackingRule | NoParamTrackingRule | ArtifactsFollowedTrackingRule, generation_rules: list[GenerationRule], id: int, user: User, generated_last_week: int = 0)[source]

Bases: NewRule

generated_last_week: int
id: int
model_config = {'from_attributes': True}

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

user: User
class fmn.api.api_models.RulePatch(*, disabled: bool | None = None)[source]

Bases: BaseModel

disabled: bool | None
model_config = {'from_attributes': True}

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

class fmn.api.api_models.User(*, id: int | None = None, name: str, is_admin: bool = False)[source]

Bases: BaseModel

id: int | None
is_admin: bool
model_config = {'from_attributes': True}

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

name: str