Apache Atlas REST API — Entities

naftiko: 1.0.0-alpha2
info:
  label: Apache Atlas REST API — Entities
  description: 'Apache Atlas REST API — Entities. 4 operations. Lead operation: Apache Atlas Create or Update Entities in
    Bulk. Self-contained Naftiko capability covering one Apache Atlas business surface.'
  tags:
  - Apache Atlas
  - Entities
  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-entities
    baseUri: http://localhost:21000/api/atlas
    description: Apache Atlas REST API — Entities business capability. Self-contained, no shared references.
    resources:
    - name: v2-entity-bulk
      path: /v2/entity/bulk
      operations:
      - name: createorupdateentities
        method: POST
        description: Apache Atlas Create or Update Entities in Bulk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v2-entity-guid-guid
      path: /v2/entity/guid/{guid}
      operations:
      - name: getentitybyguid
        method: GET
        description: Apache Atlas Get Entity by GUID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          description: Unique identifier (GUID) of the entity.
          required: true
        - name: minExtInfo
          in: query
          type: boolean
          description: If true, minimize related entity information in the response.
        - name: ignoreRelationships
          in: query
          type: boolean
          description: If true, ignore relationship attributes in the response.
      - name: updateentitybyguid
        method: PUT
        description: Apache Atlas Update Entity by GUID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          description: Unique identifier (GUID) of the entity to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteentitybyguid
        method: DELETE
        description: Apache Atlas Delete Entity by GUID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: guid
          in: path
          type: string
          description: Unique identifier (GUID) of the entity to delete.
          required: true
    authentication:
      type: basic
      username: '{{env.APACHE_ATLAS_USER}}'
      password: '{{env.APACHE_ATLAS_PASS}}'
  exposes:
  - type: rest
    namespace: rest-entities-rest
    port: 8080
    description: REST adapter for Apache Atlas REST API — Entities. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/entity/bulk
      name: v2-entity-bulk
      description: REST surface for v2-entity-bulk.
      operations:
      - method: POST
        name: createorupdateentities
        description: Apache Atlas Create or Update Entities in Bulk
        call: rest-entities.createorupdateentities
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/entity/guid/{guid}
      name: v2-entity-guid-guid
      description: REST surface for v2-entity-guid-guid.
      operations:
      - method: GET
        name: getentitybyguid
        description: Apache Atlas Get Entity by GUID
        call: rest-entities.getentitybyguid
        with:
          guid: rest.guid
          minExtInfo: rest.minExtInfo
          ignoreRelationships: rest.ignoreRelationships
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateentitybyguid
        description: Apache Atlas Update Entity by GUID
        call: rest-entities.updateentitybyguid
        with:
          guid: rest.guid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteentitybyguid
        description: Apache Atlas Delete Entity by GUID
        call: rest-entities.deleteentitybyguid
        with:
          guid: rest.guid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache Atlas REST API — Entities. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-atlas-create-update-entities
      description: Apache Atlas Create or Update Entities in Bulk
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-entities.createorupdateentities
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-atlas-get-entity-guid
      description: Apache Atlas Get Entity by GUID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-entities.getentitybyguid
      with:
        guid: tools.guid
        minExtInfo: tools.minExtInfo
        ignoreRelationships: tools.ignoreRelationships
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-atlas-update-entity-guid
      description: Apache Atlas Update Entity by GUID
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-entities.updateentitybyguid
      with:
        guid: tools.guid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-atlas-delete-entity-guid
      description: Apache Atlas Delete Entity by GUID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-entities.deleteentitybyguid
      with:
        guid: tools.guid
      outputParameters:
      - type: object
        mapping: $.