naftiko: 1.0.0-alpha2
info:
  label: BigID Data Catalog — Objects
  description: 'BigID Data Catalog API — Objects. 4 operations to query catalog objects, columns, attributes, and cluster
    similar columns. Self-contained Naftiko capability covering one BigID business surface.'
  tags:
    - BigID
    - Catalog
    - Metadata
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
  - namespace: env
    keys:
      BIGID_BASE_URL: BIGID_BASE_URL
      BIGID_SYSTEM_TOKEN: BIGID_SYSTEM_TOKEN
capability:
  consumes:
    - type: http
      namespace: data-catalog-objects
      baseUri: '{{env.BIGID_BASE_URL}}'
      description: BigID Data Catalog business capability.
      resources:
        - name: data-catalog
          path: /api/v1/data-catalog
          operations:
            - name: querydatacatalog
              method: GET
              description: BigID Query The Data Catalog
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: filter
                  in: query
                  type: string
                - name: limit
                  in: query
                  type: integer
                - name: offset
                  in: query
                  type: integer
        - name: catalog-columns
          path: /api/v1/data-catalog/object-details/columns
          operations:
            - name: getcatalogobjectcolumns
              method: GET
              description: BigID Get Catalog Object Columns
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: catalog-attributes
          path: /api/v1/data-catalog/object-details/attributes
          operations:
            - name: getcatalogobjectattributes
              method: GET
              description: BigID Get Catalog Object Attributes
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: catalog-similar-columns
          path: /api/v1/data-catalog/column/cluster/similar
          operations:
            - name: listsimilarclustercolumns
              method: GET
              description: BigID List Similar Cluster Columns
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: cluster_id
                  in: query
                  type: string
      authentication:
        type: bearer
        value: '{{env.BIGID_SYSTEM_TOKEN}}'
        placement: header
  exposes:
    - type: rest
      namespace: data-catalog-objects-rest
      port: 8080
      description: REST adapter for BigID Data Catalog.
      resources:
        - path: /v1/data-catalog
          name: data-catalog
          description: REST surface for data-catalog.
          operations:
            - method: GET
              name: querydatacatalog
              description: BigID Query The Data Catalog
              call: data-catalog-objects.querydatacatalog
              with:
                filter: rest.query.filter
                limit: rest.query.limit
                offset: rest.query.offset
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/data-catalog/object-details/columns
          name: catalog-columns
          description: REST surface for catalog-columns.
          operations:
            - method: GET
              name: getcatalogobjectcolumns
              description: BigID Get Catalog Object Columns
              call: data-catalog-objects.getcatalogobjectcolumns
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/data-catalog/object-details/attributes
          name: catalog-attributes
          description: REST surface for catalog-attributes.
          operations:
            - method: GET
              name: getcatalogobjectattributes
              description: BigID Get Catalog Object Attributes
              call: data-catalog-objects.getcatalogobjectattributes
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/data-catalog/column/cluster/similar
          name: catalog-similar-columns
          description: REST surface for catalog-similar-columns.
          operations:
            - method: GET
              name: listsimilarclustercolumns
              description: BigID List Similar Cluster Columns
              call: data-catalog-objects.listsimilarclustercolumns
              with:
                cluster_id: rest.query.cluster_id
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: data-catalog-objects-mcp
      port: 9090
      transport: http
      description: MCP adapter for BigID Data Catalog.
      tools:
        - name: bigid-query-data-catalog
          description: BigID Query The Data Catalog
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: data-catalog-objects.querydatacatalog
          with:
            filter: tools.filter
            limit: tools.limit
            offset: tools.offset
          outputParameters:
            - type: object
              mapping: $.
        - name: bigid-get-catalog-columns
          description: BigID Get Catalog Object Columns
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: data-catalog-objects.getcatalogobjectcolumns
          outputParameters:
            - type: object
              mapping: $.
        - name: bigid-get-catalog-attributes
          description: BigID Get Catalog Object Attributes
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: data-catalog-objects.getcatalogobjectattributes
          outputParameters:
            - type: object
              mapping: $.
        - name: bigid-list-similar-cluster-columns
          description: BigID List Similar Cluster Columns
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: data-catalog-objects.listsimilarclustercolumns
          with:
            cluster_id: tools.cluster_id
          outputParameters:
            - type: object
              mapping: $.