Candid Essentials API — Lookup

naftiko: 1.0.0-alpha2
info:
  label: Candid Essentials API — Lookup
  description: 'Candid Essentials API — Lookup. 3 operations. Lead operation: List Lookup Filters. Self-contained Naftiko
    capability covering one Candid business surface.'
  tags:
  - Candid
  - Lookup
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CANDID_API_KEY: CANDID_API_KEY
capability:
  consumes:
  - type: http
    namespace: essentials-lookup
    baseUri: https://api.candid.org/essentials
    description: Candid Essentials API — Lookup business capability. Self-contained, no shared references.
    resources:
    - name: lookup
      path: /lookup
      operations:
      - name: listlookupfilters
        method: GET
        description: List Lookup Filters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: lookup-filter_name
      path: /lookup/{filter_name}
      operations:
      - name: getlookupbyfilter
        method: GET
        description: Get Lookup Values for Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter_name
          in: path
          type: string
          description: Name of the lookup filter to retrieve values for.
          required: true
    - name: lookup-filter_name-key_or_value
      path: /lookup/{filter_name}/{key_or_value}
      operations:
      - name: getlookupbyfilterandkey
        method: GET
        description: Get Lookup Detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter_name
          in: path
          type: string
          description: Name of the lookup filter.
          required: true
        - name: key_or_value
          in: path
          type: string
          description: Key or value within the lookup filter to retrieve.
          required: true
    authentication:
      type: apikey
      key: Subscription-Key
      value: '{{env.CANDID_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: essentials-lookup-rest
    port: 8080
    description: REST adapter for Candid Essentials API — Lookup. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/lookup
      name: lookup
      description: REST surface for lookup.
      operations:
      - method: GET
        name: listlookupfilters
        description: List Lookup Filters
        call: essentials-lookup.listlookupfilters
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lookup/{filter-name}
      name: lookup-filter-name
      description: REST surface for lookup-filter_name.
      operations:
      - method: GET
        name: getlookupbyfilter
        description: Get Lookup Values for Filter
        call: essentials-lookup.getlookupbyfilter
        with:
          filter_name: rest.filter_name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lookup/{filter-name}/{key-or-value}
      name: lookup-filter-name-key-or-value
      description: REST surface for lookup-filter_name-key_or_value.
      operations:
      - method: GET
        name: getlookupbyfilterandkey
        description: Get Lookup Detail
        call: essentials-lookup.getlookupbyfilterandkey
        with:
          filter_name: rest.filter_name
          key_or_value: rest.key_or_value
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: essentials-lookup-mcp
    port: 9090
    transport: http
    description: MCP adapter for Candid Essentials API — Lookup. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-lookup-filters
      description: List Lookup Filters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: essentials-lookup.listlookupfilters
      outputParameters:
      - type: object
        mapping: $.
    - name: get-lookup-values-filter
      description: Get Lookup Values for Filter
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: essentials-lookup.getlookupbyfilter
      with:
        filter_name: tools.filter_name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-lookup-detail
      description: Get Lookup Detail
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: essentials-lookup.getlookupbyfilterandkey
      with:
        filter_name: tools.filter_name
        key_or_value: tools.key_or_value
      outputParameters:
      - type: object
        mapping: $.