Apache Atlas REST API — Types

naftiko: 1.0.0-alpha2
info:
  label: Apache Atlas REST API — Types
  description: 'Apache Atlas REST API — Types. 2 operations. Lead operation: Apache Atlas Get All Type Definitions. Self-contained
    Naftiko capability covering one Apache Atlas business surface.'
  tags:
  - Apache Atlas
  - Types
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_ATLAS_API_KEY: APACHE_ATLAS_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-types
    baseUri: http://localhost:21000/api/atlas
    description: Apache Atlas REST API — Types business capability. Self-contained, no shared references.
    resources:
    - name: v2-types-typedefs
      path: /v2/types/typedefs
      operations:
      - name: getalltypedefs
        method: GET
        description: Apache Atlas Get All Type Definitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: Filter by type category (CLASSIFICATION, ENTITY, ENUM, RELATIONSHIP, STRUCT, BUSINESS_METADATA).
      - name: createtypedefs
        method: POST
        description: Apache Atlas Create Type Definitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.APACHE_ATLAS_USER}}'
      password: '{{env.APACHE_ATLAS_PASS}}'
  exposes:
  - type: rest
    namespace: rest-types-rest
    port: 8080
    description: REST adapter for Apache Atlas REST API — Types. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v2/types/typedefs
      name: v2-types-typedefs
      description: REST surface for v2-types-typedefs.
      operations:
      - method: GET
        name: getalltypedefs
        description: Apache Atlas Get All Type Definitions
        call: rest-types.getalltypedefs
        with:
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createtypedefs
        description: Apache Atlas Create Type Definitions
        call: rest-types.createtypedefs
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-types-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache Atlas REST API — Types. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: apache-atlas-get-all-type
      description: Apache Atlas Get All Type Definitions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-types.getalltypedefs
      with:
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-atlas-create-type-definitions
      description: Apache Atlas Create Type Definitions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-types.createtypedefs
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.