bayesline.api.FeatureDefinition

bayesline.api.FeatureDefinition#

model FeatureDefinition#

What a feature is, as the application that owns it states it.

Presented under its fully qualified "<group>.<name>"; neither half may contain a period, which is what makes that alias unambiguous.

Fields#

Field

Type

Required

Default

Constraints

default_data

dict[str, Any]

No

factory

default_enabled

bool

Yes

description

str

Yes

group

str

Yes

pattern=``^[A-Za-z0-9_-]+$``

is_editable

bool

Yes

name

str

Yes

pattern=``^[A-Za-z0-9_-]+$``

field default_data: dict[str, Any] [Optional]#
field default_enabled: bool [Required]#
field description: str [Required]#
field group: str [Required]#
Constraints:
  • pattern = ^[A-Za-z0-9_-]+$

field is_editable: bool [Required]#
field name: str [Required]#
Constraints:
  • pattern = ^[A-Za-z0-9_-]+$