Microsoft Purview Unified Catalog API — Data Products

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Unified Catalog API — Data Products
  description: 'Microsoft Purview Unified Catalog API — Data Products. 5 operations. Lead operation: Microsoft Purview List
    data products. Self-contained Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - Data Products
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_PURVIEW_API_KEY: MICROSOFT_PURVIEW_API_KEY
capability:
  consumes:
  - type: http
    namespace: unified-catalog-data-products
    baseUri: https://{accountName}.purview.azure.com
    description: Microsoft Purview Unified Catalog API — Data Products business capability. Self-contained, no shared references.
    resources:
    - name: dataproducts
      path: /dataproducts
      operations:
      - name: listdataproducts
        method: GET
        description: Microsoft Purview List data products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api-version
          in: query
          type: string
          required: true
        - name: maxpagesize
          in: query
          type: integer
      - name: createdataproduct
        method: POST
        description: Microsoft Purview Create a data product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: dataproducts-dataProductId
      path: /dataproducts/{dataProductId}
      operations:
      - name: getdataproduct
        method: GET
        description: Microsoft Purview Get a data product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataProductId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
      - name: updatedataproduct
        method: PATCH
        description: Microsoft Purview Update a data product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataProductId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletedataproduct
        method: DELETE
        description: Microsoft Purview Delete a data product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataProductId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_PURVIEW_API_KEY}}'
  exposes:
  - type: rest
    namespace: unified-catalog-data-products-rest
    port: 8080
    description: REST adapter for Microsoft Purview Unified Catalog API — Data Products. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/dataproducts
      name: dataproducts
      description: REST surface for dataproducts.
      operations:
      - method: GET
        name: listdataproducts
        description: Microsoft Purview List data products
        call: unified-catalog-data-products.listdataproducts
        with:
          api-version: rest.api-version
          maxpagesize: rest.maxpagesize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdataproduct
        description: Microsoft Purview Create a data product
        call: unified-catalog-data-products.createdataproduct
        with:
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dataproducts/{dataproductid}
      name: dataproducts-dataproductid
      description: REST surface for dataproducts-dataProductId.
      operations:
      - method: GET
        name: getdataproduct
        description: Microsoft Purview Get a data product
        call: unified-catalog-data-products.getdataproduct
        with:
          dataProductId: rest.dataProductId
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatedataproduct
        description: Microsoft Purview Update a data product
        call: unified-catalog-data-products.updatedataproduct
        with:
          dataProductId: rest.dataProductId
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedataproduct
        description: Microsoft Purview Delete a data product
        call: unified-catalog-data-products.deletedataproduct
        with:
          dataProductId: rest.dataProductId
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: unified-catalog-data-products-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Unified Catalog API — Data Products. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: microsoft-purview-list-data-products
      description: Microsoft Purview List data products
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unified-catalog-data-products.listdataproducts
      with:
        api-version: tools.api-version
        maxpagesize: tools.maxpagesize
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-create-data-product
      description: Microsoft Purview Create a data product
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: unified-catalog-data-products.createdataproduct
      with:
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-get-data-product
      description: Microsoft Purview Get a data product
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unified-catalog-data-products.getdataproduct
      with:
        dataProductId: tools.dataProductId
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-update-data-product
      description: Microsoft Purview Update a data product
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: unified-catalog-data-products.updatedataproduct
      with:
        dataProductId: tools.dataProductId
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-delete-data-product
      description: Microsoft Purview Delete a data product
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: unified-catalog-data-products.deletedataproduct
      with:
        dataProductId: tools.dataProductId
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.