id: https://nde.nl/ontology/hc/class/SearchAPI
name: SearchAPI
title: Search API
prefixes:
  linkml: https://w3id.org/linkml/
  hc: https://nde.nl/ontology/hc/
  dcat: http://www.w3.org/ns/dcat#
  dcterms: http://purl.org/dc/terms/
  schema: http://schema.org/
  hydra: http://www.w3.org/ns/hydra/core#
  xsd: http://www.w3.org/2001/XMLSchema#
default_prefix: hc
imports:
  - linkml:types
  - ../enums/HTTPMethodEnum
  - ../enums/PaginationMethodEnum
  - ../enums/SearchResponseFormatEnum
  - ../metadata
  - ../slots/has_score
  - ../slots/has_format
  - ../slots/has_url
  - ../slots/has_name
  - ../slots/has_description
  - ../slots/required
classes:
  SearchAPI:
    is_a: DataServiceEndpoint
    class_uri: hc:SearchAPI
    description: REST/JSON search API endpoint for heritage collection discovery.
    comments:
      - Primary interface for programmatic collection discovery
      - Most heritage institutions expose REST/JSON search APIs
      - Consider rate limits and pagination for large-scale harvesting
      - |
        Common capabilities:
        - Full-text and field-specific search
        - Faceted filtering
        - Pagination and sorting
      - |
        Typical response fields (varies by API):
        - total
        - results/items/records
        - facets
        - pagination links or cursors
    see_also:
      - https://opensearch.org/
      - https://www.hydra-cg.com/spec/latest/core/
    slots:
      - has_score
      - has_name
      - has_url
      - has_format
    examples:
      - value:
          has_name: Nationaal Archief Search API
          has_url: https://www.nationaalarchief.nl/onderzoeken/api/zoeken
          has_format:
            - https://www.iana.org/assignments/media-types/application/json
        description: Example search API endpoint.
    annotations:
      specificity_score: 0.1
      specificity_rationale: Generic utility class/slot created during migration
      custodian_types: "['*']"
  SearchQueryParameter:
    class_uri: hydra:IriTemplateMapping
    description: Query parameter supported by a search API.
    slots:
      - has_score
      - has_name
      - has_description
      - required