Microsoft Purview Unified Catalog API — Business Domains

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Unified Catalog API — Business Domains
  description: 'Microsoft Purview Unified Catalog API — Business Domains. 5 operations. Lead operation: Microsoft Purview
    List business domains. Self-contained Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - Business Domains
  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-business-domains
    baseUri: https://{accountName}.purview.azure.com
    description: Microsoft Purview Unified Catalog API — Business Domains business capability. Self-contained, no shared references.
    resources:
    - name: businessdomains
      path: /businessdomains
      operations:
      - name: listbusinessdomains
        method: GET
        description: Microsoft Purview List business domains
        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: skipToken
          in: query
          type: string
      - name: createbusinessdomain
        method: POST
        description: Microsoft Purview Create a business domain
        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: businessdomains-businessDomainId
      path: /businessdomains/{businessDomainId}
      operations:
      - name: getbusinessdomain
        method: GET
        description: Microsoft Purview Get a business domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: businessDomainId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
      - name: updatebusinessdomain
        method: PATCH
        description: Microsoft Purview Update a business domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: businessDomainId
          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: deletebusinessdomain
        method: DELETE
        description: Microsoft Purview Delete a business domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: businessDomainId
          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-business-domains-rest
    port: 8080
    description: REST adapter for Microsoft Purview Unified Catalog API — Business Domains. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/businessdomains
      name: businessdomains
      description: REST surface for businessdomains.
      operations:
      - method: GET
        name: listbusinessdomains
        description: Microsoft Purview List business domains
        call: unified-catalog-business-domains.listbusinessdomains
        with:
          api-version: rest.api-version
          maxpagesize: rest.maxpagesize
          skipToken: rest.skipToken
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbusinessdomain
        description: Microsoft Purview Create a business domain
        call: unified-catalog-business-domains.createbusinessdomain
        with:
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/businessdomains/{businessdomainid}
      name: businessdomains-businessdomainid
      description: REST surface for businessdomains-businessDomainId.
      operations:
      - method: GET
        name: getbusinessdomain
        description: Microsoft Purview Get a business domain
        call: unified-catalog-business-domains.getbusinessdomain
        with:
          businessDomainId: rest.businessDomainId
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatebusinessdomain
        description: Microsoft Purview Update a business domain
        call: unified-catalog-business-domains.updatebusinessdomain
        with:
          businessDomainId: rest.businessDomainId
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebusinessdomain
        description: Microsoft Purview Delete a business domain
        call: unified-catalog-business-domains.deletebusinessdomain
        with:
          businessDomainId: rest.businessDomainId
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: unified-catalog-business-domains-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Unified Catalog API — Business Domains. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: microsoft-purview-list-business-domains
      description: Microsoft Purview List business domains
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unified-catalog-business-domains.listbusinessdomains
      with:
        api-version: tools.api-version
        maxpagesize: tools.maxpagesize
        skipToken: tools.skipToken
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-create-business-domain
      description: Microsoft Purview Create a business domain
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: unified-catalog-business-domains.createbusinessdomain
      with:
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-get-business-domain
      description: Microsoft Purview Get a business domain
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unified-catalog-business-domains.getbusinessdomain
      with:
        businessDomainId: tools.businessDomainId
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-update-business-domain
      description: Microsoft Purview Update a business domain
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: unified-catalog-business-domains.updatebusinessdomain
      with:
        businessDomainId: tools.businessDomainId
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-delete-business-domain
      description: Microsoft Purview Delete a business domain
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: unified-catalog-business-domains.deletebusinessdomain
      with:
        businessDomainId: tools.businessDomainId
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.