Microsoft Purview Catalog API — Type

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Catalog API — Type
  description: 'Microsoft Purview Catalog API — Type. 8 operations. Lead operation: Microsoft Purview Get type definition
    by GUID. Self-contained Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - Type
  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-type
    baseUri: https://{accountName}.purview.azure.com/catalog
    description: Microsoft Purview Catalog API — Type business capability. Self-contained, no shared references.
    resources:
    - name: api-atlas-v2-types-typedef-guid-guid
      path: /api/atlas/v2/types/typedef/guid/{guid}
      operations:
      - name: gettypedefinitionbyguid
        method: GET
        description: Microsoft Purview Get type definition by GUID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          required: true
    - name: api-atlas-v2-types-typedef-name-name
      path: /api/atlas/v2/types/typedef/name/{name}
      operations:
      - name: gettypedefinitionbyname
        method: GET
        description: Microsoft Purview Get type definition by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: deletetypedefinitionbyname
        method: DELETE
        description: Microsoft Purview Delete type definition by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: api-atlas-v2-types-typedefs
      path: /api/atlas/v2/types/typedefs
      operations:
      - name: listtypedefinitions
        method: GET
        description: Microsoft Purview List all type definitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeTermTemplate
          in: query
          type: boolean
          description: Whether to include term template definitions
        - name: type
          in: query
          type: string
          description: Type category filter
      - name: bulkcreatetypedefinitions
        method: POST
        description: Microsoft Purview Create type definitions in bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: bulkupdatetypedefinitions
        method: PUT
        description: Microsoft Purview Update type definitions in bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: bulkdeletetypedefinitions
        method: DELETE
        description: Microsoft Purview Delete type definitions in bulk
        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-types-typedefs-headers
      path: /api/atlas/v2/types/typedefs/headers
      operations:
      - name: listtypedefinitionheaders
        method: GET
        description: Microsoft Purview List type definition headers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeTermTemplate
          in: query
          type: boolean
        - name: type
          in: query
          type: string
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_PURVIEW_API_KEY}}'
  exposes:
  - type: rest
    namespace: catalog-type-rest
    port: 8080
    description: REST adapter for Microsoft Purview Catalog API — Type. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/atlas/v2/types/typedef/guid/{guid}
      name: api-atlas-v2-types-typedef-guid-guid
      description: REST surface for api-atlas-v2-types-typedef-guid-guid.
      operations:
      - method: GET
        name: gettypedefinitionbyguid
        description: Microsoft Purview Get type definition by GUID
        call: catalog-type.gettypedefinitionbyguid
        with:
          guid: rest.guid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/types/typedef/name/{name}
      name: api-atlas-v2-types-typedef-name-name
      description: REST surface for api-atlas-v2-types-typedef-name-name.
      operations:
      - method: GET
        name: gettypedefinitionbyname
        description: Microsoft Purview Get type definition by name
        call: catalog-type.gettypedefinitionbyname
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletetypedefinitionbyname
        description: Microsoft Purview Delete type definition by name
        call: catalog-type.deletetypedefinitionbyname
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/types/typedefs
      name: api-atlas-v2-types-typedefs
      description: REST surface for api-atlas-v2-types-typedefs.
      operations:
      - method: GET
        name: listtypedefinitions
        description: Microsoft Purview List all type definitions
        call: catalog-type.listtypedefinitions
        with:
          includeTermTemplate: rest.includeTermTemplate
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: bulkcreatetypedefinitions
        description: Microsoft Purview Create type definitions in bulk
        call: catalog-type.bulkcreatetypedefinitions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: bulkupdatetypedefinitions
        description: Microsoft Purview Update type definitions in bulk
        call: catalog-type.bulkupdatetypedefinitions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: bulkdeletetypedefinitions
        description: Microsoft Purview Delete type definitions in bulk
        call: catalog-type.bulkdeletetypedefinitions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/atlas/v2/types/typedefs/headers
      name: api-atlas-v2-types-typedefs-headers
      description: REST surface for api-atlas-v2-types-typedefs-headers.
      operations:
      - method: GET
        name: listtypedefinitionheaders
        description: Microsoft Purview List type definition headers
        call: catalog-type.listtypedefinitionheaders
        with:
          includeTermTemplate: rest.includeTermTemplate
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-type-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Catalog API — Type. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: microsoft-purview-get-type-definition
      description: Microsoft Purview Get type definition by GUID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-type.gettypedefinitionbyguid
      with:
        guid: tools.guid
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-get-type-definition-2
      description: Microsoft Purview Get type definition by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-type.gettypedefinitionbyname
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-delete-type-definition
      description: Microsoft Purview Delete type definition by name
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-type.deletetypedefinitionbyname
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-list-all-type
      description: Microsoft Purview List all type definitions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-type.listtypedefinitions
      with:
        includeTermTemplate: tools.includeTermTemplate
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-create-type-definitions
      description: Microsoft Purview Create type definitions in bulk
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-type.bulkcreatetypedefinitions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-update-type-definitions
      description: Microsoft Purview Update type definitions in bulk
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-type.bulkupdatetypedefinitions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-delete-type-definitions
      description: Microsoft Purview Delete type definitions in bulk
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-type.bulkdeletetypedefinitions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-list-type-definition
      description: Microsoft Purview List type definition headers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-type.listtypedefinitionheaders
      with:
        includeTermTemplate: tools.includeTermTemplate
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.