ZAP API — ruleConfig

naftiko: 1.0.0-alpha2
info:
  label: ZAP API — ruleConfig
  description: 'ZAP API — ruleConfig. 5 operations. Lead operation: ruleConfig. Self-contained Naftiko capability covering
    one Owasp Zap business surface.'
  tags:
  - Owasp Zap
  - ruleConfig
  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-ruleconfig
    baseUri: http://zap
    description: ZAP API — ruleConfig business capability. Self-contained, no shared references.
    resources:
    - name: JSON-ruleConfig-action-resetAllRuleConfigValues
      path: /JSON/ruleConfig/action/resetAllRuleConfigValues/
      operations:
      - name: ruleconfigactionresetallruleconfigvalues
        method: GET
        description: Reset all of the rule configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-ruleConfig-action-resetRuleConfigValue
      path: /JSON/ruleConfig/action/resetRuleConfigValue/
      operations:
      - name: ruleconfigactionresetruleconfigvalue
        method: GET
        description: Reset the specified rule configuration, which must already exist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-ruleConfig-action-setRuleConfigValue
      path: /JSON/ruleConfig/action/setRuleConfigValue/
      operations:
      - name: ruleconfigactionsetruleconfigvalue
        method: GET
        description: Set the specified rule configuration, which must already exist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-ruleConfig-view-allRuleConfigs
      path: /JSON/ruleConfig/view/allRuleConfigs/
      operations:
      - name: ruleconfigviewallruleconfigs
        method: GET
        description: Show all of the rule configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-ruleConfig-view-ruleConfigValue
      path: /JSON/ruleConfig/view/ruleConfigValue/
      operations:
      - name: ruleconfigviewruleconfigvalue
        method: GET
        description: Show the specified rule configuration
        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-ruleconfig-rest
    port: 8080
    description: REST adapter for ZAP API — ruleConfig. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/json/ruleconfig/action/resetallruleconfigvalues
      name: json-ruleconfig-action-resetallruleconfigvalues
      description: REST surface for JSON-ruleConfig-action-resetAllRuleConfigValues.
      operations:
      - method: GET
        name: ruleconfigactionresetallruleconfigvalues
        description: Reset all of the rule configurations
        call: owasp-zap-ruleconfig.ruleconfigactionresetallruleconfigvalues
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/ruleconfig/action/resetruleconfigvalue
      name: json-ruleconfig-action-resetruleconfigvalue
      description: REST surface for JSON-ruleConfig-action-resetRuleConfigValue.
      operations:
      - method: GET
        name: ruleconfigactionresetruleconfigvalue
        description: Reset the specified rule configuration, which must already exist
        call: owasp-zap-ruleconfig.ruleconfigactionresetruleconfigvalue
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/ruleconfig/action/setruleconfigvalue
      name: json-ruleconfig-action-setruleconfigvalue
      description: REST surface for JSON-ruleConfig-action-setRuleConfigValue.
      operations:
      - method: GET
        name: ruleconfigactionsetruleconfigvalue
        description: Set the specified rule configuration, which must already exist
        call: owasp-zap-ruleconfig.ruleconfigactionsetruleconfigvalue
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/ruleconfig/view/allruleconfigs
      name: json-ruleconfig-view-allruleconfigs
      description: REST surface for JSON-ruleConfig-view-allRuleConfigs.
      operations:
      - method: GET
        name: ruleconfigviewallruleconfigs
        description: Show all of the rule configurations
        call: owasp-zap-ruleconfig.ruleconfigviewallruleconfigs
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/ruleconfig/view/ruleconfigvalue
      name: json-ruleconfig-view-ruleconfigvalue
      description: REST surface for JSON-ruleConfig-view-ruleConfigValue.
      operations:
      - method: GET
        name: ruleconfigviewruleconfigvalue
        description: Show the specified rule configuration
        call: owasp-zap-ruleconfig.ruleconfigviewruleconfigvalue
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: owasp-zap-ruleconfig-mcp
    port: 9090
    transport: http
    description: MCP adapter for ZAP API — ruleConfig. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: reset-all-rule-configurations
      description: Reset all of the rule configurations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-ruleconfig.ruleconfigactionresetallruleconfigvalues
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-specified-rule-configuration-which
      description: Reset the specified rule configuration, which must already exist
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-ruleconfig.ruleconfigactionresetruleconfigvalue
      outputParameters:
      - type: object
        mapping: $.
    - name: set-specified-rule-configuration-which
      description: Set the specified rule configuration, which must already exist
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-ruleconfig.ruleconfigactionsetruleconfigvalue
      outputParameters:
      - type: object
        mapping: $.
    - name: show-all-rule-configurations
      description: Show all of the rule configurations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-ruleconfig.ruleconfigviewallruleconfigs
      outputParameters:
      - type: object
        mapping: $.
    - name: show-specified-rule-configuration
      description: Show the specified rule configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-ruleconfig.ruleconfigviewruleconfigvalue
      outputParameters:
      - type: object
        mapping: $.