fmn.api.api_models module

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

Bases: BaseModel

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

Bases: BaseModel

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

Bases: BaseModel

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

Bases: BaseModel

class Config[source]

Bases: object

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

Bases: BaseModel

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

Bases: BaseModel

applications: list[str]
my_actions: bool
severities: list[str]
topic: str | None
class fmn.api.api_models.GRGetterDict(obj: Any)[source]

Bases: GetterDict

get(key: str, default: Any) → Any[source]
class fmn.api.api_models.GenerationRule(*, id: int | None = None, destinations: list[fmn.api.api_models.Destination], filters: Filters)[source]

Bases: BaseModel

class Config[source]

Bases: object

getter_dict

alias of GRGetterDict

destinations: list[fmn.api.api_models.Destination]
filters: Filters
id: int | None
class fmn.api.api_models.ListParamTrackingRule(*, name: Literal['artifacts-owned', 'artifacts-group-owned', 'users-followed'], params: list[str])[source]

Bases: BaseModel

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[fmn.api.api_models.GenerationRule])[source]

Bases: BaseModel

disabled: bool
generation_rules: list[fmn.api.api_models.GenerationRule]
name: str | None
tracking_rule: ListParamTrackingRule | NoParamTrackingRule | ArtifactsFollowedTrackingRule
class fmn.api.api_models.NoParamTrackingRule(*, name: Literal['related-events'], params: str | None = None)[source]

Bases: BaseModel

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

Bases: GenericModel, Generic[T]

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

Bases: NewRule

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

Bases: BaseModel

disabled: bool | None
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
name: str