DVIDS API — Search

naftiko: 1.0.0-alpha2
info:
  label: DVIDS API — Search
  description: 'DVIDS API — Search. 1 operations. Lead operation: Search assets. Self-contained Naftiko capability covering
    one Dvids Api business surface.'
  tags:
  - Dvids Api
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DVIDS_API_API_KEY: DVIDS_API_API_KEY
capability:
  consumes:
  - type: http
    namespace: dvids-search
    baseUri: https://api.dvidshub.net
    description: DVIDS API — Search business capability. Self-contained, no shared references.
    resources:
    - name: search
      path: /search
      operations:
      - name: searchassets
        method: GET
        description: Search assets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api_key
          in: query
          type: string
          required: true
        - name: q
          in: query
          type: string
        - name: branch
          in: query
          type: string
        - name: type
          in: query
          type: string
        - name: category
          in: query
          type: string
        - name: categories_exclude
          in: query
          type: string
        - name: country
          in: query
          type: string
        - name: state
          in: query
          type: string
        - name: city
          in: query
          type: string
        - name: unit_name
          in: query
          type: string
        - name: unit
          in: query
          type: string
        - name: unit_id
          in: query
          type: integer
        - name: credit
          in: query
          type: string
        - name: from_date
          in: query
          type: string
        - name: to_date
          in: query
          type: string
        - name: from_publishdate
          in: query
          type: string
        - name: to_publishdate
          in: query
          type: string
        - name: timestamp
          in: query
          type: string
        - name: from_duration
          in: query
          type: integer
        - name: to_duration
          in: query
          type: integer
        - name: aspect_ratio
          in: query
          type: string
        - name: hd
          in: query
          type: integer
        - name: has_image
          in: query
          type: boolean
        - name: has_captions
          in: query
          type: boolean
        - name: max_results
          in: query
          type: integer
        - name: page
          in: query
          type: integer
        - name: sort
          in: query
          type: string
        - name: sortdir
          in: query
          type: string
        - name: format
          in: query
          type: string
        - name: fields
          in: query
          type: string
        - name: thumb_width
          in: query
          type: integer
        - name: thumb_height
          in: query
          type: integer
        - name: thumb_quality
          in: query
          type: integer
    authentication:
      type: apikey
      key: api_key
      value: '{{env.DVIDS_API_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: dvids-search-rest
    port: 8080
    description: REST adapter for DVIDS API — Search. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/search
      name: search
      description: REST surface for search.
      operations:
      - method: GET
        name: searchassets
        description: Search assets
        call: dvids-search.searchassets
        with:
          api_key: rest.api_key
          q: rest.q
          branch: rest.branch
          type: rest.type
          category: rest.category
          categories_exclude: rest.categories_exclude
          country: rest.country
          state: rest.state
          city: rest.city
          unit_name: rest.unit_name
          unit: rest.unit
          unit_id: rest.unit_id
          credit: rest.credit
          from_date: rest.from_date
          to_date: rest.to_date
          from_publishdate: rest.from_publishdate
          to_publishdate: rest.to_publishdate
          timestamp: rest.timestamp
          from_duration: rest.from_duration
          to_duration: rest.to_duration
          aspect_ratio: rest.aspect_ratio
          hd: rest.hd
          has_image: rest.has_image
          has_captions: rest.has_captions
          max_results: rest.max_results
          page: rest.page
          sort: rest.sort
          sortdir: rest.sortdir
          format: rest.format
          fields: rest.fields
          thumb_width: rest.thumb_width
          thumb_height: rest.thumb_height
          thumb_quality: rest.thumb_quality
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: dvids-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for DVIDS API — Search. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: search-assets
      description: Search assets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: dvids-search.searchassets
      with:
        api_key: tools.api_key
        q: tools.q
        branch: tools.branch
        type: tools.type
        category: tools.category
        categories_exclude: tools.categories_exclude
        country: tools.country
        state: tools.state
        city: tools.city
        unit_name: tools.unit_name
        unit: tools.unit
        unit_id: tools.unit_id
        credit: tools.credit
        from_date: tools.from_date
        to_date: tools.to_date
        from_publishdate: tools.from_publishdate
        to_publishdate: tools.to_publishdate
        timestamp: tools.timestamp
        from_duration: tools.from_duration
        to_duration: tools.to_duration
        aspect_ratio: tools.aspect_ratio
        hd: tools.hd
        has_image: tools.has_image
        has_captions: tools.has_captions
        max_results: tools.max_results
        page: tools.page
        sort: tools.sort
        sortdir: tools.sortdir
        format: tools.format
        fields: tools.fields
        thumb_width: tools.thumb_width
        thumb_height: tools.thumb_height
        thumb_quality: tools.thumb_quality
      outputParameters:
      - type: object
        mapping: $.