id: https://nde.nl/ontology/hc/class/SearchQueryParameter
name: search_query_parameter
title: Search Query Parameter Class
prefixes:
  linkml: https://w3id.org/linkml/
  hc: https://nde.nl/ontology/hc/
  dcterms: http://purl.org/dc/terms/
  schema: http://schema.org/
  hydra: http://www.w3.org/ns/hydra/core#
imports:
  - linkml:types
  - ../slots/specificity_annotation
  - ./SpecificityAnnotation
  - ../slots/template_specificity
  - ./TemplateSpecificityScores
default_prefix: hc

classes:
  SearchQueryParameter:
    class_uri: hydra:IriTemplateMapping
    description: |
      Describes a query parameter supported by a search API.

      Documents the parameter name, type, whether it's required,
      and its purpose.
    attributes:
      name:
        slot_uri: hydra:variable
        description: |
          Parameter name as used in the query string.

          Example: "q", "type", "from", "size"
        range: string
        required: true
      type:
        slot_uri: hydra:property
        description: |
          Data type of the parameter value.

          Values: string, integer, boolean, date, array
        range: string
      required:
        slot_uri: hydra:required
        description: |
          Whether this parameter is required.
        range: boolean
      description:
        slot_uri: dcterms:description
        description: |
          Human-readable description of the parameter.

          Example: "Full-text search query"
        range: string
      default_value:
        slot_uri: schema:defaultValue
        description: |
          Default value if not specified.

          Example: "10" for a size parameter
        range: string
      allowed_values:
        slot_uri: schema:valueReference
        description: |
          List of allowed values (for enumerated parameters).

          Example: ["image", "document", "audio", "video"]
        range: string
        multivalued: true
      example_value:
        slot_uri: schema:workExample
        description: |
          Example value for this parameter.

          Example: "amsterdam museum"
        range: string
    slots:
      - specificity_annotation
      - template_specificity
    slot_usage:
      specificity_annotation:
        range: SpecificityAnnotation
        inlined: true
      template_specificity:
        range: TemplateSpecificityScores
        inlined: true