Class: ToolParameter¶

A configurable parameter for a tool. Supports string, number, boolean, and enum types with optional default values, explicit choices, and schema-defined parameter type references.

URI: debrief:class/ToolParameter

 classDiagram
    class ToolParameter
    click ToolParameter href "../../classes/ToolParameter/"
      ToolParameter : default_value

      ToolParameter : description

      ToolParameter : name

      ToolParameter : param_type





        ToolParameter --> "0..1" ParameterTypeEnum : param_type
        click ParameterTypeEnum href "../../enums/ParameterTypeEnum/"



      ToolParameter : required

      ToolParameter : type

Slots¶

Name	Cardinality and Range	Description	Inheritance
name	1 String	Parameter identifier (kebab-case)	direct
type	1 String	Value type discriminator: string, number, boolean, enum	direct
description	1 String	Human-readable parameter description	direct
required	0..1 Boolean	Whether parameter must be provided	direct
default_value	0..1 String	Default value if not provided	direct
param_type	0..1 ParameterTypeEnum	References a schema-defined parameter-type enum by name	direct

Identifier and Mapping Information¶

Schema Source¶

from schema: https://debrief.info/schemas/debrief

Mappings¶

Mapping Type	Mapped Value
self	debrief:ToolParameter
native	debrief:ToolParameter

LinkML Source¶

Direct¶

name: ToolParameter
description: A configurable parameter for a tool. Supports string, number, boolean,
  and enum types with optional default values, explicit choices, and schema-defined
  parameter type references.
from_schema: https://debrief.info/schemas/debrief
attributes:
  name:
    name: name
    description: Parameter identifier (kebab-case)
    from_schema: https://debrief.info/schemas/tool
    domain_of:
    - SegmentMetadata
    - SensorData
    - TUAData
    - PointMetadataEntry
    - ReferenceLocationProperties
    - Tool
    - ToolParameter
    - PlatformRecord
    - LevelDefinition
    - DatasetSeries
    range: string
    required: true
  type:
    name: type
    description: 'Value type discriminator: string, number, boolean, enum'
    from_schema: https://debrief.info/schemas/tool
    domain_of:
    - GeoJSONPoint
    - GeoJSONEmptyPoint
    - GeoJSONLineString
    - GeoJSONPolygon
    - GeoJSONMultiPoint
    - GeoJSONMultiLineString
    - GeoJSONMultiPolygon
    - TrackFeature
    - ReferenceLocation
    - SystemState
    - MultiPointFeature
    - MultiPolygonFeature
    - NarrativeEntry
    - CircleAnnotation
    - RectangleAnnotation
    - LineAnnotation
    - TextAnnotation
    - VectorAnnotation
    - PolyAnnotation
    - ToolParameter
    - FileProvEntry
    - GeoJSONGeometry
    - GeoJSONFeature
    - DatasetAxisMetadata
    - DatasetEntry
    range: string
    required: true
  description:
    name: description
    description: Human-readable parameter description
    from_schema: https://debrief.info/schemas/tool
    domain_of:
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - Tool
    - ToolParameter
    - LevelDefinition
    range: string
    required: true
  required:
    name: required
    description: Whether parameter must be provided
    from_schema: https://debrief.info/schemas/tool
    rank: 1000
    domain_of:
    - ToolParameter
    range: boolean
    required: false
  default_value:
    name: default_value
    description: Default value if not provided
    from_schema: https://debrief.info/schemas/tool
    rank: 1000
    domain_of:
    - ToolParameter
    range: string
    required: false
  param_type:
    name: param_type
    description: References a schema-defined parameter-type enum by name. When set,
      the client resolves enum values from generated types rather than using inline
      choices.
    from_schema: https://debrief.info/schemas/tool
    rank: 1000
    domain_of:
    - ToolParameter
    range: ParameterTypeEnum
    required: false

Induced¶

name: ToolParameter
description: A configurable parameter for a tool. Supports string, number, boolean,
  and enum types with optional default values, explicit choices, and schema-defined
  parameter type references.
from_schema: https://debrief.info/schemas/debrief
attributes:
  name:
    name: name
    description: Parameter identifier (kebab-case)
    from_schema: https://debrief.info/schemas/tool
    alias: name
    owner: ToolParameter
    domain_of:
    - SegmentMetadata
    - SensorData
    - TUAData
    - PointMetadataEntry
    - ReferenceLocationProperties
    - Tool
    - ToolParameter
    - PlatformRecord
    - LevelDefinition
    - DatasetSeries
    range: string
    required: true
  type:
    name: type
    description: 'Value type discriminator: string, number, boolean, enum'
    from_schema: https://debrief.info/schemas/tool
    alias: type
    owner: ToolParameter
    domain_of:
    - GeoJSONPoint
    - GeoJSONEmptyPoint
    - GeoJSONLineString
    - GeoJSONPolygon
    - GeoJSONMultiPoint
    - GeoJSONMultiLineString
    - GeoJSONMultiPolygon
    - TrackFeature
    - ReferenceLocation
    - SystemState
    - MultiPointFeature
    - MultiPolygonFeature
    - NarrativeEntry
    - CircleAnnotation
    - RectangleAnnotation
    - LineAnnotation
    - TextAnnotation
    - VectorAnnotation
    - PolyAnnotation
    - ToolParameter
    - FileProvEntry
    - GeoJSONGeometry
    - GeoJSONFeature
    - DatasetAxisMetadata
    - DatasetEntry
    range: string
    required: true
  description:
    name: description
    description: Human-readable parameter description
    from_schema: https://debrief.info/schemas/tool
    alias: description
    owner: ToolParameter
    domain_of:
    - ReferenceLocationProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - Tool
    - ToolParameter
    - LevelDefinition
    range: string
    required: true
  required:
    name: required
    description: Whether parameter must be provided
    from_schema: https://debrief.info/schemas/tool
    rank: 1000
    alias: required
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: boolean
    required: false
  default_value:
    name: default_value
    description: Default value if not provided
    from_schema: https://debrief.info/schemas/tool
    rank: 1000
    alias: default_value
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: string
    required: false
  param_type:
    name: param_type
    description: References a schema-defined parameter-type enum by name. When set,
      the client resolves enum values from generated types rather than using inline
      choices.
    from_schema: https://debrief.info/schemas/tool
    rank: 1000
    alias: param_type
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: ParameterTypeEnum
    required: false