Nected API

naftiko: 1.0.0-alpha2
info:
  label: Nected API
  description: 'Nected API. 12 operations. Lead operation: Search audit logs. Self-contained Naftiko capability covering one
    Nected business surface.'
  tags:
  - Nected
  - Nected API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NECTED_API_KEY: NECTED_API_KEY
capability:
  consumes:
  - type: http
    namespace: nected
    baseUri: https://api.nected.ai
    description: Nected API business capability. Self-contained, no shared references.
    resources:
    - name: dev-audit-audit-search
      path: /dev/audit/audit/search
      operations:
      - name: searchauditlogs
        method: GET
        description: Search audit logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pageNo
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
        - name: search
          in: query
          type: string
        - name: type
          in: query
          type: string
        - name: event
          in: query
          type: string
        - name: status
          in: query
          type: string
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
    - name: dev-audit-audit-logId
      path: /dev/audit/audit/{logId}
      operations:
      - name: getauditlog
        method: GET
        description: Get audit log detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: logId
          in: path
          type: string
          required: true
    - name: dev-usage
      path: /dev/usage
      operations:
      - name: checkusage
        method: GET
        description: Check usage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: dev-variable
      path: /dev/variable
      operations:
      - name: listglobalvariables
        method: GET
        description: List global variables
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createglobalvariable
        method: POST
        description: Create a global variable
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: dev-variable-name
      path: /dev/variable/{name}
      operations:
      - name: getglobalvariable
        method: GET
        description: Get a global variable
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: updateglobalvariable
        method: PATCH
        description: Update a global variable
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: checksum
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteglobalvariable
        method: DELETE
        description: Delete a global variable
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: checksum
          in: header
          type: string
          required: true
    - name: dev-entityType
      path: /dev/{entityType}
      operations:
      - name: listentities
        method: GET
        description: List rules or workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entityType
          in: path
          type: string
          required: true
        - name: page
          in: query
          type: integer
        - name: perPage
          in: query
          type: integer
        - name: sortBy
          in: query
          type: string
        - name: sortDir
          in: query
          type: string
        - name: status
          in: query
          type: string
        - name: name
          in: query
          type: string
        - name: type
          in: query
          type: string
        - name: q
          in: query
          type: string
        - name: tags
          in: query
          type: string
        - name: createdAtFrom
          in: query
          type: string
        - name: createdAtTo
          in: query
          type: string
        - name: updatedAtFrom
          in: query
          type: string
        - name: updatedAtTo
          in: query
          type: string
        - name: createdBy
          in: query
          type: string
        - name: updatedBy
          in: query
          type: string
    - name: dev-entityType-entityId
      path: /dev/{entityType}/{entityId}
      operations:
      - name: getentity
        method: GET
        description: Get rule or workflow detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entityType
          in: path
          type: string
          required: true
        - name: entityId
          in: path
          type: string
          required: true
        - name: view
          in: query
          type: string
        - name: include
          in: query
          type: string
        - name: version
          in: query
          type: string
        - name: expand
          in: query
          type: string
    - name: nected-rule-ruleId
      path: /nected/rule/{ruleId}
      operations:
      - name: triggerrule
        method: POST
        description: Trigger a rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ruleId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: nected-workflow-workflowId
      path: /nected/workflow/{workflowId}
      operations:
      - name: triggerworkflow
        method: POST
        description: Trigger a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: nected-api-key
      value: '{{env.NECTED_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: nected-rest
    port: 8080
    description: REST adapter for Nected API. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/dev/audit/audit/search
      name: dev-audit-audit-search
      description: REST surface for dev-audit-audit-search.
      operations:
      - method: GET
        name: searchauditlogs
        description: Search audit logs
        call: nected.searchauditlogs
        with:
          pageNo: rest.pageNo
          pageSize: rest.pageSize
          search: rest.search
          type: rest.type
          event: rest.event
          status: rest.status
          startDate: rest.startDate
          endDate: rest.endDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dev/audit/audit/{logid}
      name: dev-audit-audit-logid
      description: REST surface for dev-audit-audit-logId.
      operations:
      - method: GET
        name: getauditlog
        description: Get audit log detail
        call: nected.getauditlog
        with:
          logId: rest.logId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dev/usage
      name: dev-usage
      description: REST surface for dev-usage.
      operations:
      - method: GET
        name: checkusage
        description: Check usage
        call: nected.checkusage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dev/variable
      name: dev-variable
      description: REST surface for dev-variable.
      operations:
      - method: GET
        name: listglobalvariables
        description: List global variables
        call: nected.listglobalvariables
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createglobalvariable
        description: Create a global variable
        call: nected.createglobalvariable
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dev/variable/{name}
      name: dev-variable-name
      description: REST surface for dev-variable-name.
      operations:
      - method: GET
        name: getglobalvariable
        description: Get a global variable
        call: nected.getglobalvariable
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateglobalvariable
        description: Update a global variable
        call: nected.updateglobalvariable
        with:
          name: rest.name
          checksum: rest.checksum
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteglobalvariable
        description: Delete a global variable
        call: nected.deleteglobalvariable
        with:
          name: rest.name
          checksum: rest.checksum
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dev/{entitytype}
      name: dev-entitytype
      description: REST surface for dev-entityType.
      operations:
      - method: GET
        name: listentities
        description: List rules or workflows
        call: nected.listentities
        with:
          entityType: rest.entityType
          page: rest.page
          perPage: rest.perPage
          sortBy: rest.sortBy
          sortDir: rest.sortDir
          status: rest.status
          name: rest.name
          type: rest.type
          q: rest.q
          tags: rest.tags
          createdAtFrom: rest.createdAtFrom
          createdAtTo: rest.createdAtTo
          updatedAtFrom: rest.updatedAtFrom
          updatedAtTo: rest.updatedAtTo
          createdBy: rest.createdBy
          updatedBy: rest.updatedBy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dev/{entitytype}/{entityid}
      name: dev-entitytype-entityid
      description: REST surface for dev-entityType-entityId.
      operations:
      - method: GET
        name: getentity
        description: Get rule or workflow detail
        call: nected.getentity
        with:
          entityType: rest.entityType
          entityId: rest.entityId
          view: rest.view
          include: rest.include
          version: rest.version
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/nected/rule/{ruleid}
      name: nected-rule-ruleid
      description: REST surface for nected-rule-ruleId.
      operations:
      - method: POST
        name: triggerrule
        description: Trigger a rule
        call: nected.triggerrule
        with:
          ruleId: rest.ruleId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/nected/workflow/{workflowid}
      name: nected-workflow-workflowid
      description: REST surface for nected-workflow-workflowId.
      operations:
      - method: POST
        name: triggerworkflow
        description: Trigger a workflow
        call: nected.triggerworkflow
        with:
          workflowId: rest.workflowId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: nected-mcp
    port: 9090
    transport: http
    description: MCP adapter for Nected API. One tool per consumed operation, routed inline through this capability's consumes
      block.
    tools:
    - name: search-audit-logs
      description: Search audit logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nected.searchauditlogs
      with:
        pageNo: tools.pageNo
        pageSize: tools.pageSize
        search: tools.search
        type: tools.type
        event: tools.event
        status: tools.status
        startDate: tools.startDate
        endDate: tools.endDate
      outputParameters:
      - type: object
        mapping: $.
    - name: get-audit-log-detail
      description: Get audit log detail
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nected.getauditlog
      with:
        logId: tools.logId
      outputParameters:
      - type: object
        mapping: $.
    - name: check-usage
      description: Check usage
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nected.checkusage
      outputParameters:
      - type: object
        mapping: $.
    - name: list-global-variables
      description: List global variables
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nected.listglobalvariables
      outputParameters:
      - type: object
        mapping: $.
    - name: create-global-variable
      description: Create a global variable
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nected.createglobalvariable
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-global-variable
      description: Get a global variable
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nected.getglobalvariable
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-global-variable
      description: Update a global variable
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: nected.updateglobalvariable
      with:
        name: tools.name
        checksum: tools.checksum
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-global-variable
      description: Delete a global variable
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: nected.deleteglobalvariable
      with:
        name: tools.name
        checksum: tools.checksum
      outputParameters:
      - type: object
        mapping: $.
    - name: list-rules-workflows
      description: List rules or workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nected.listentities
      with:
        entityType: tools.entityType
        page: tools.page
        perPage: tools.perPage
        sortBy: tools.sortBy
        sortDir: tools.sortDir
        status: tools.status
        name: tools.name
        type: tools.type
        q: tools.q
        tags: tools.tags
        createdAtFrom: tools.createdAtFrom
        createdAtTo: tools.createdAtTo
        updatedAtFrom: tools.updatedAtFrom
        updatedAtTo: tools.updatedAtTo
        createdBy: tools.createdBy
        updatedBy: tools.updatedBy
      outputParameters:
      - type: object
        mapping: $.
    - name: get-rule-workflow-detail
      description: Get rule or workflow detail
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nected.getentity
      with:
        entityType: tools.entityType
        entityId: tools.entityId
        view: tools.view
        include: tools.include
        version: tools.version
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-rule
      description: Trigger a rule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nected.triggerrule
      with:
        ruleId: tools.ruleId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-workflow
      description: Trigger a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nected.triggerworkflow
      with:
        workflowId: tools.workflowId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.