DVIDS API — Asset

naftiko: 1.0.0-alpha2
info:
  label: DVIDS API — Asset
  description: 'DVIDS API — Asset. 2 operations. Lead operation: Get asset. Self-contained Naftiko capability covering one
    Dvids Api business surface.'
  tags:
  - Dvids Api
  - Asset
  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-asset
    baseUri: https://api.dvidshub.net
    description: DVIDS API — Asset business capability. Self-contained, no shared references.
    resources:
    - name: asset
      path: /asset
      operations:
      - name: getasset
        method: GET
        description: Get asset
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api_key
          in: query
          type: string
          required: true
        - name: id
          in: query
          type: string
          required: true
        - name: fields
          in: query
          type: string
        - name: prettyprint
          in: query
          type: boolean
        - name: thumb_width
          in: query
          type: integer
        - name: thumb_height
          in: query
          type: integer
        - name: thumb_quality
          in: query
          type: integer
        - name: include_related_media
          in: query
          type: boolean
    - name: asset-related
      path: /asset/related
      operations:
      - name: getrelatedassets
        method: GET
        description: Get related assets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api_key
          in: query
          type: string
          required: true
        - name: id
          in: query
          type: string
          required: true
        - name: branch
          in: query
          type: string
        - name: category
          in: query
          type: string
        - name: type
          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: credit
          in: query
          type: string
        - name: from_date
          in: query
          type: string
        - name: to_date
          in: query
          type: string
        - name: aspect_ratio
          in: query
          type: string
        - name: hd
          in: query
          type: integer
        - name: max_results
          in: query
          type: integer
        - name: page
          in: query
          type: integer
    authentication:
      type: apikey
      key: api_key
      value: '{{env.DVIDS_API_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: dvids-asset-rest
    port: 8080
    description: REST adapter for DVIDS API — Asset. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/asset
      name: asset
      description: REST surface for asset.
      operations:
      - method: GET
        name: getasset
        description: Get asset
        call: dvids-asset.getasset
        with:
          api_key: rest.api_key
          id: rest.id
          fields: rest.fields
          prettyprint: rest.prettyprint
          thumb_width: rest.thumb_width
          thumb_height: rest.thumb_height
          thumb_quality: rest.thumb_quality
          include_related_media: rest.include_related_media
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/asset/related
      name: asset-related
      description: REST surface for asset-related.
      operations:
      - method: GET
        name: getrelatedassets
        description: Get related assets
        call: dvids-asset.getrelatedassets
        with:
          api_key: rest.api_key
          id: rest.id
          branch: rest.branch
          category: rest.category
          type: rest.type
          country: rest.country
          state: rest.state
          city: rest.city
          unit_name: rest.unit_name
          credit: rest.credit
          from_date: rest.from_date
          to_date: rest.to_date
          aspect_ratio: rest.aspect_ratio
          hd: rest.hd
          max_results: rest.max_results
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: dvids-asset-mcp
    port: 9090
    transport: http
    description: MCP adapter for DVIDS API — Asset. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-asset
      description: Get asset
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: dvids-asset.getasset
      with:
        api_key: tools.api_key
        id: tools.id
        fields: tools.fields
        prettyprint: tools.prettyprint
        thumb_width: tools.thumb_width
        thumb_height: tools.thumb_height
        thumb_quality: tools.thumb_quality
        include_related_media: tools.include_related_media
      outputParameters:
      - type: object
        mapping: $.
    - name: get-related-assets
      description: Get related assets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: dvids-asset.getrelatedassets
      with:
        api_key: tools.api_key
        id: tools.id
        branch: tools.branch
        category: tools.category
        type: tools.type
        country: tools.country
        state: tools.state
        city: tools.city
        unit_name: tools.unit_name
        credit: tools.credit
        from_date: tools.from_date
        to_date: tools.to_date
        aspect_ratio: tools.aspect_ratio
        hd: tools.hd
        max_results: tools.max_results
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.