ts_ids_core.schema.parameter module

Model Parameter

Bases: IdsElement

A structure for capturing individual values with varying datatypes.

Show JSON schema

{
   "description": "A structure for capturing individual values with varying datatypes.",
   "type": "object",
   "properties": {
      "key": {
         "description": "This is the property name.",
         "type": "string"
      },
      "value": {
         "description": "The original string value of the parameter from the raw file.",
         "type": "string"
      },
      "value_data_type": {
         "$ref": "#/definitions/ValueDataType",
         "description": "This is the true type of the original value."
      },
      "string_value": {
         "description": "If string_value has a value, then numerical_value, numerical_value_unit and boolean_value have to be null.",
         "type": [
            "string",
            "null"
         ]
      },
      "numerical_value": {
         "description": "If numerical_value has a value, then string_value and boolean_value have to be null.",
         "type": [
            "number",
            "null"
         ]
      },
      "numerical_value_unit": {
         "description": "Unit for the numerical value.",
         "type": [
            "string",
            "null"
         ]
      },
      "boolean_value": {
         "description": "If boolean_value has a value, then numerical_value, numerical_value_unit and string_value have to be null.",
         "type": [
            "boolean",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "definitions": {
      "ValueDataType": {
         "description": "Allowed data type values.",
         "enum": [
            "string",
            "number",
            "boolean"
         ],
         "type": "string"
      }
   }
}

Validators:

• all_abstract_fields_implemented » all fields

field boolean_value: Nullable[bool]

If boolean_value has a value, then numerical_value, numerical_value_unit and string_value have to be null.

field key: str

This is the property name.

field numerical_value: Nullable[float]

If numerical_value has a value, then string_value and boolean_value have to be null.

field numerical_value_unit: Nullable[str]

Unit for the numerical value.

field string_value: Nullable[str]

If string_value has a value, then numerical_value, numerical_value_unit and boolean_value have to be null.

field value: str

The original string value of the parameter from the raw file.

field value_data_type: ValueDataType

This is the true type of the original value.