ZAP API — automation

naftiko: 1.0.0-alpha2
info:
  label: ZAP API — automation
  description: 'ZAP API — automation. 3 operations. Lead operation: automation. Self-contained Naftiko capability covering
    one Owasp Zap business surface.'
  tags:
  - Owasp Zap
  - automation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OWASP_ZAP_API_KEY: OWASP_ZAP_API_KEY
capability:
  consumes:
  - type: http
    namespace: owasp-zap-automation
    baseUri: http://zap
    description: ZAP API — automation business capability. Self-contained, no shared references.
    resources:
    - name: JSON-automation-action-endDelayJob
      path: /JSON/automation/action/endDelayJob/
      operations:
      - name: automationactionenddelayjob
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-automation-action-runPlan
      path: /JSON/automation/action/runPlan/
      operations:
      - name: automationactionrunplan
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-automation-view-planProgress
      path: /JSON/automation/view/planProgress/
      operations:
      - name: automationviewplanprogress
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-ZAP-API-Key
      value: '{{env.OWASP_ZAP_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: owasp-zap-automation-rest
    port: 8080
    description: REST adapter for ZAP API — automation. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/json/automation/action/enddelayjob
      name: json-automation-action-enddelayjob
      description: REST surface for JSON-automation-action-endDelayJob.
      operations:
      - method: GET
        name: automationactionenddelayjob
        description: automationactionenddelayjob
        call: owasp-zap-automation.automationactionenddelayjob
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/automation/action/runplan
      name: json-automation-action-runplan
      description: REST surface for JSON-automation-action-runPlan.
      operations:
      - method: GET
        name: automationactionrunplan
        description: automationactionrunplan
        call: owasp-zap-automation.automationactionrunplan
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/automation/view/planprogress
      name: json-automation-view-planprogress
      description: REST surface for JSON-automation-view-planProgress.
      operations:
      - method: GET
        name: automationviewplanprogress
        description: automationviewplanprogress
        call: owasp-zap-automation.automationviewplanprogress
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: owasp-zap-automation-mcp
    port: 9090
    transport: http
    description: MCP adapter for ZAP API — automation. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: automationactionenddelayjob
      description: automationactionenddelayjob
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-automation.automationactionenddelayjob
      outputParameters:
      - type: object
        mapping: $.
    - name: automationactionrunplan
      description: automationactionrunplan
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-automation.automationactionrunplan
      outputParameters:
      - type: object
        mapping: $.
    - name: automationviewplanprogress
      description: automationviewplanprogress
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-automation.automationviewplanprogress
      outputParameters:
      - type: object
        mapping: $.