omnipy.components.isa.models.protocol_parameter_schema

CLASS	DESCRIPTION
FieldType
IsaProtocolParameterModel
IsaProtocolParameterSchema

FieldType

Bases: Enum

ATTRIBUTE	DESCRIPTION
ProtocolParameter

Source code in src/omnipy/components/isa/models/protocol_parameter_schema.py

class FieldType(Enum):
    ProtocolParameter = 'ProtocolParameter'

ProtocolParameter class-attribute instance-attribute

ProtocolParameter = 'ProtocolParameter'

IsaProtocolParameterModel

Bases: Model[IsaProtocolParameterSchema]

Source code in src/omnipy/components/isa/models/protocol_parameter_schema.py

class IsaProtocolParameterModel(Model[IsaProtocolParameterSchema]):
    ...

IsaProtocolParameterSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
Config

ATTRIBUTE	DESCRIPTION
comments	TYPE: Optional[List[comment_schema.IsaCommentModel]]
field_context	TYPE: Optional[str]
field_id	TYPE: Optional[str]
field_type	TYPE: Optional[FieldType]
parameterName	TYPE: Optional[ontology_annotation_schema.IsaOntologyReferenceModel]

Source code in src/omnipy/components/isa/models/protocol_parameter_schema.py

class IsaProtocolParameterSchema(pyd.BaseModel):
    class Config:
        extra = pyd.Extra.forbid
        use_enum_values = True

    field_id: Optional[str] = pyd.Field(None, alias='@id')
    field_context: Optional[str] = pyd.Field(None, alias='@context')
    field_type: Optional[FieldType] = pyd.Field(None, alias='@type')
    parameterName: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = (None)
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

comments class-attribute instance-attribute

comments: Optional[List[comment_schema.IsaCommentModel]] = None

field_context class-attribute instance-attribute

field_context: Optional[str] = pyd.Field(None, alias='@context')

field_id class-attribute instance-attribute

field_id: Optional[str] = pyd.Field(None, alias='@id')

field_type class-attribute instance-attribute

field_type: Optional[FieldType] = pyd.Field(None, alias='@type')

parameterName class-attribute instance-attribute

parameterName: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None

Config

ATTRIBUTE	DESCRIPTION
extra
use_enum_values

Source code in src/omnipy/components/isa/models/protocol_parameter_schema.py

class Config:
    extra = pyd.Extra.forbid
    use_enum_values = True

extra class-attribute instance-attribute

extra = pyd.Extra.forbid

use_enum_values class-attribute instance-attribute

use_enum_values = True