Amazon Neptune Data API — openCypher

naftiko: 1.0.0-alpha2
info:
  label: Amazon Neptune Data API — openCypher
  description: 'Amazon Neptune Data API — openCypher. 5 operations. Lead operation: Amazon Neptune Execute an OpenCypher Query
    via the Data API. Self-contained Naftiko capability covering one Amazon Neptune business surface.'
  tags:
  - Amazon Neptune
  - openCypher
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AMAZON_NEPTUNE_API_KEY: AMAZON_NEPTUNE_API_KEY
capability:
  consumes:
  - type: http
    namespace: data-opencypher
    baseUri: https://neptune-db.{region}.amazonaws.com
    description: Amazon Neptune Data API — openCypher business capability. Self-contained, no shared references.
    resources:
    - name: opencypher
      path: /opencypher
      operations:
      - name: executeopencypherquery
        method: POST
        description: Amazon Neptune Execute an OpenCypher Query via the Data API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: opencypher-explain
      path: /opencypher/explain
      operations:
      - name: executeopencypherexplainquery
        method: POST
        description: Amazon Neptune Get the Execution Plan for an OpenCypher Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: opencypher-status
      path: /opencypher/status
      operations:
      - name: getopencypherquerystatus
        method: GET
        description: Amazon Neptune Get the Status of OpenCypher Queries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: opencypher-status-queryId
      path: /opencypher/status/{queryId}
      operations:
      - name: getopencypherquerystatusbyid
        method: GET
        description: Amazon Neptune Get the Status of a Specific OpenCypher Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryId
          in: path
          type: string
          description: The unique identifier of the openCypher query.
          required: true
      - name: cancelopencypherquery
        method: DELETE
        description: Amazon Neptune Cancel a Running OpenCypher Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryId
          in: path
          type: string
          description: The unique identifier of the openCypher query to cancel.
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.AMAZON_NEPTUNE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: data-opencypher-rest
    port: 8080
    description: REST adapter for Amazon Neptune Data API — openCypher. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/opencypher
      name: opencypher
      description: REST surface for opencypher.
      operations:
      - method: POST
        name: executeopencypherquery
        description: Amazon Neptune Execute an OpenCypher Query via the Data API
        call: data-opencypher.executeopencypherquery
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/opencypher/explain
      name: opencypher-explain
      description: REST surface for opencypher-explain.
      operations:
      - method: POST
        name: executeopencypherexplainquery
        description: Amazon Neptune Get the Execution Plan for an OpenCypher Query
        call: data-opencypher.executeopencypherexplainquery
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/opencypher/status
      name: opencypher-status
      description: REST surface for opencypher-status.
      operations:
      - method: GET
        name: getopencypherquerystatus
        description: Amazon Neptune Get the Status of OpenCypher Queries
        call: data-opencypher.getopencypherquerystatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/opencypher/status/{queryid}
      name: opencypher-status-queryid
      description: REST surface for opencypher-status-queryId.
      operations:
      - method: GET
        name: getopencypherquerystatusbyid
        description: Amazon Neptune Get the Status of a Specific OpenCypher Query
        call: data-opencypher.getopencypherquerystatusbyid
        with:
          queryId: rest.queryId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: cancelopencypherquery
        description: Amazon Neptune Cancel a Running OpenCypher Query
        call: data-opencypher.cancelopencypherquery
        with:
          queryId: rest.queryId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: data-opencypher-mcp
    port: 9090
    transport: http
    description: MCP adapter for Amazon Neptune Data API — openCypher. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: amazon-neptune-execute-opencypher-query
      description: Amazon Neptune Execute an OpenCypher Query via the Data API
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: data-opencypher.executeopencypherquery
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: amazon-neptune-get-execution-plan
      description: Amazon Neptune Get the Execution Plan for an OpenCypher Query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: data-opencypher.executeopencypherexplainquery
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: amazon-neptune-get-status-opencypher
      description: Amazon Neptune Get the Status of OpenCypher Queries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-opencypher.getopencypherquerystatus
      outputParameters:
      - type: object
        mapping: $.
    - name: amazon-neptune-get-status-specific
      description: Amazon Neptune Get the Status of a Specific OpenCypher Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: data-opencypher.getopencypherquerystatusbyid
      with:
        queryId: tools.queryId
      outputParameters:
      - type: object
        mapping: $.
    - name: amazon-neptune-cancel-running-opencypher
      description: Amazon Neptune Cancel a Running OpenCypher Query
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: data-opencypher.cancelopencypherquery
      with:
        queryId: tools.queryId
      outputParameters:
      - type: object
        mapping: $.