Microsoft Purview Catalog API — Relationship

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Catalog API — Relationship
  description: 'Microsoft Purview Catalog API — Relationship. 4 operations. Lead operation: Microsoft Purview Create a relationship.
    Self-contained Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - Relationship
  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: catalog-relationship
    baseUri: https://{accountName}.purview.azure.com/catalog
    description: Microsoft Purview Catalog API — Relationship business capability. Self-contained, no shared references.
    resources:
    - name: api-atlas-v2-relationship
      path: /api/atlas/v2/relationship
      operations:
      - name: createrelationship
        method: POST
        description: Microsoft Purview Create a relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updaterelationship
        method: PUT
        description: Microsoft Purview Update a relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-atlas-v2-relationship-guid-guid
      path: /api/atlas/v2/relationship/guid/{guid}
      operations:
      - name: getrelationship
        method: GET
        description: Microsoft Purview Get relationship by GUID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
        - name: extendedInfo
          in: query
          type: boolean
          description: Whether to return extended information
      - name: deleterelationship
        method: DELETE
        description: Microsoft Purview Delete a relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_PURVIEW_API_KEY}}'
  exposes:
  - type: rest
    namespace: catalog-relationship-rest
    port: 8080
    description: REST adapter for Microsoft Purview Catalog API — Relationship. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/atlas/v2/relationship
      name: api-atlas-v2-relationship
      description: REST surface for api-atlas-v2-relationship.
      operations:
      - method: POST
        name: createrelationship
        description: Microsoft Purview Create a relationship
        call: catalog-relationship.createrelationship
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterelationship
        description: Microsoft Purview Update a relationship
        call: catalog-relationship.updaterelationship
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/relationship/guid/{guid}
      name: api-atlas-v2-relationship-guid-guid
      description: REST surface for api-atlas-v2-relationship-guid-guid.
      operations:
      - method: GET
        name: getrelationship
        description: Microsoft Purview Get relationship by GUID
        call: catalog-relationship.getrelationship
        with:
          guid: rest.guid
          extendedInfo: rest.extendedInfo
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterelationship
        description: Microsoft Purview Delete a relationship
        call: catalog-relationship.deleterelationship
        with:
          guid: rest.guid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-relationship-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Catalog API — Relationship. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: microsoft-purview-create-relationship
      description: Microsoft Purview Create a relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-relationship.createrelationship
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-update-relationship
      description: Microsoft Purview Update a relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-relationship.updaterelationship
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-get-relationship-guid
      description: Microsoft Purview Get relationship by GUID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-relationship.getrelationship
      with:
        guid: tools.guid
        extendedInfo: tools.extendedInfo
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-delete-relationship
      description: Microsoft Purview Delete a relationship
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-relationship.deleterelationship
      with:
        guid: tools.guid
      outputParameters:
      - type: object
        mapping: $.