ZAP API — reveal

naftiko: 1.0.0-alpha2
info:
  label: ZAP API — reveal
  description: 'ZAP API — reveal. 2 operations. Lead operation: reveal. Self-contained Naftiko capability covering one Owasp
    Zap business surface.'
  tags:
  - Owasp Zap
  - reveal
  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-reveal
    baseUri: http://zap
    description: ZAP API — reveal business capability. Self-contained, no shared references.
    resources:
    - name: JSON-reveal-action-setReveal
      path: /JSON/reveal/action/setReveal/
      operations:
      - name: revealactionsetreveal
        method: GET
        description: Sets if shows hidden fields and enables disabled fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-reveal-view-reveal
      path: /JSON/reveal/view/reveal/
      operations:
      - name: revealviewreveal
        method: GET
        description: Tells if shows hidden fields and enables disabled fields
        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-reveal-rest
    port: 8080
    description: REST adapter for ZAP API — reveal. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/json/reveal/action/setreveal
      name: json-reveal-action-setreveal
      description: REST surface for JSON-reveal-action-setReveal.
      operations:
      - method: GET
        name: revealactionsetreveal
        description: Sets if shows hidden fields and enables disabled fields
        call: owasp-zap-reveal.revealactionsetreveal
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/reveal/view/reveal
      name: json-reveal-view-reveal
      description: REST surface for JSON-reveal-view-reveal.
      operations:
      - method: GET
        name: revealviewreveal
        description: Tells if shows hidden fields and enables disabled fields
        call: owasp-zap-reveal.revealviewreveal
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: owasp-zap-reveal-mcp
    port: 9090
    transport: http
    description: MCP adapter for ZAP API — reveal. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: sets-if-shows-hidden-fields
      description: Sets if shows hidden fields and enables disabled fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-reveal.revealactionsetreveal
      outputParameters:
      - type: object
        mapping: $.
    - name: tells-if-shows-hidden-fields
      description: Tells if shows hidden fields and enables disabled fields
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-reveal.revealviewreveal
      outputParameters:
      - type: object
        mapping: $.