ZAP API — hud

naftiko: 1.0.0-alpha2
info:
  label: ZAP API — hud
  description: 'ZAP API — hud. 37 operations. Lead operation: hud. Self-contained Naftiko capability covering one Owasp Zap
    business surface.'
  tags:
  - Owasp Zap
  - hud
  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-hud
    baseUri: http://zap
    description: ZAP API — hud business capability. Self-contained, no shared references.
    resources:
    - name: JSON-hud-action-log
      path: /JSON/hud/action/log/
      operations:
      - name: hudactionlog
        method: GET
        description: Used by the HUD to log messages from the browser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-recordRequest
      path: /JSON/hud/action/recordRequest/
      operations:
      - name: hudactionrecordrequest
        method: GET
        description: Used by the HUD to cache a request the user wants to send in the browser
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-resetTutorialTasks
      path: /JSON/hud/action/resetTutorialTasks/
      operations:
      - name: hudactionresettutorialtasks
        method: GET
        description: Reset the tutorial tasks so that they must be completed again
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionBaseDirectory
      path: /JSON/hud/action/setOptionBaseDirectory/
      operations:
      - name: hudactionsetoptionbasedirectory
        method: GET
        description: Set the base directory from which the HUD files are loaded
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionDevelopmentMode
      path: /JSON/hud/action/setOptionDevelopmentMode/
      operations:
      - name: hudactionsetoptiondevelopmentmode
        method: GET
        description: Sets the boolean option 'Development mode'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionEnableOnDomainMsgs
      path: /JSON/hud/action/setOptionEnableOnDomainMsgs/
      operations:
      - name: hudactionsetoptionenableondomainmsgs
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionEnabledForDaemon
      path: /JSON/hud/action/setOptionEnabledForDaemon/
      operations:
      - name: hudactionsetoptionenabledfordaemon
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionEnabledForDesktop
      path: /JSON/hud/action/setOptionEnabledForDesktop/
      operations:
      - name: hudactionsetoptionenabledfordesktop
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionInScopeOnly
      path: /JSON/hud/action/setOptionInScopeOnly/
      operations:
      - name: hudactionsetoptioninscopeonly
        method: GET
        description: Sets the boolean option 'In scope only'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionRemoveCSP
      path: /JSON/hud/action/setOptionRemoveCSP/
      operations:
      - name: hudactionsetoptionremovecsp
        method: GET
        description: Sets the boolean option 'Remove CSP'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionShowWelcomeScreen
      path: /JSON/hud/action/setOptionShowWelcomeScreen/
      operations:
      - name: hudactionsetoptionshowwelcomescreen
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionSkipTutorialTasks
      path: /JSON/hud/action/setOptionSkipTutorialTasks/
      operations:
      - name: hudactionsetoptionskiptutorialtasks
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionTutorialTaskDone
      path: /JSON/hud/action/setOptionTutorialTaskDone/
      operations:
      - name: hudactionsetoptiontutorialtaskdone
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setOptionTutorialTestMode
      path: /JSON/hud/action/setOptionTutorialTestMode/
      operations:
      - name: hudactionsetoptiontutorialtestmode
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-action-setUiOption
      path: /JSON/hud/action/setUiOption/
      operations:
      - name: hudactionsetuioption
        method: GET
        description: Sets a UI option with the given key and value. The key must be 50 or fewer alphanumeric characters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-getUiOption
      path: /JSON/hud/view/getUiOption/
      operations:
      - name: hudviewgetuioption
        method: GET
        description: Gets a UI option set using setUiOption. If the supplied key is not set then an empty string is returned
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-heartbeat
      path: /JSON/hud/view/heartbeat/
      operations:
      - name: hudviewheartbeat
        method: GET
        description: Used by service workers to keep alive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-hudAlertData
      path: /JSON/hud/view/hudAlertData/
      operations:
      - name: hudviewhudalertdata
        method: GET
        description: Returns the alert summary needed by the HUD for the specified URL
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionAllowUnsafeEval
      path: /JSON/hud/view/optionAllowUnsafeEval/
      operations:
      - name: hudviewoptionallowunsafeeval
        method: GET
        description: Returns true if the 'Allow unsafe-eval' option is set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionBaseDirectory
      path: /JSON/hud/view/optionBaseDirectory/
      operations:
      - name: hudviewoptionbasedirectory
        method: GET
        description: Returns the base directory from which the HUD files are loaded
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionDevelopmentMode
      path: /JSON/hud/view/optionDevelopmentMode/
      operations:
      - name: hudviewoptiondevelopmentmode
        method: GET
        description: Returns true if the 'Development mode' option is set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionEnableOnDomainMsgs
      path: /JSON/hud/view/optionEnableOnDomainMsgs/
      operations:
      - name: hudviewoptionenableondomainmsgs
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionEnableTelemetry
      path: /JSON/hud/view/optionEnableTelemetry/
      operations:
      - name: hudviewoptionenabletelemetry
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionEnabledForDaemon
      path: /JSON/hud/view/optionEnabledForDaemon/
      operations:
      - name: hudviewoptionenabledfordaemon
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionEnabledForDesktop
      path: /JSON/hud/view/optionEnabledForDesktop/
      operations:
      - name: hudviewoptionenabledfordesktop
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionInScopeOnly
      path: /JSON/hud/view/optionInScopeOnly/
      operations:
      - name: hudviewoptioninscopeonly
        method: GET
        description: Returns true if the 'In scope only' option is set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionRemoveCSP
      path: /JSON/hud/view/optionRemoveCSP/
      operations:
      - name: hudviewoptionremovecsp
        method: GET
        description: Returns true if the 'Remove CSP' option is set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionShowWelcomeScreen
      path: /JSON/hud/view/optionShowWelcomeScreen/
      operations:
      - name: hudviewoptionshowwelcomescreen
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionSkipTutorialTasks
      path: /JSON/hud/view/optionSkipTutorialTasks/
      operations:
      - name: hudviewoptionskiptutorialtasks
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionTutorialHost
      path: /JSON/hud/view/optionTutorialHost/
      operations:
      - name: hudviewoptiontutorialhost
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionTutorialPort
      path: /JSON/hud/view/optionTutorialPort/
      operations:
      - name: hudviewoptiontutorialport
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionTutorialTasksDone
      path: /JSON/hud/view/optionTutorialTasksDone/
      operations:
      - name: hudviewoptiontutorialtasksdone
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionTutorialTestMode
      path: /JSON/hud/view/optionTutorialTestMode/
      operations:
      - name: hudviewoptiontutorialtestmode
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-optionTutorialUpdates
      path: /JSON/hud/view/optionTutorialUpdates/
      operations:
      - name: hudviewoptiontutorialupdates
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-tutorialUpdates
      path: /JSON/hud/view/tutorialUpdates/
      operations:
      - name: hudviewtutorialupdates
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: JSON-hud-view-upgradedDomains
      path: /JSON/hud/view/upgradedDomains/
      operations:
      - name: hudviewupgradeddomains
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: OTHER-hud-other-changesInHtml
      path: /OTHER/hud/other/changesInHtml/
      operations:
      - name: hudotherchangesinhtml
        method: GET
        description: Returns the changelog in HTML format
        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-hud-rest
    port: 8080
    description: REST adapter for ZAP API — hud. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/json/hud/action/log
      name: json-hud-action-log
      description: REST surface for JSON-hud-action-log.
      operations:
      - method: GET
        name: hudactionlog
        description: Used by the HUD to log messages from the browser
        call: owasp-zap-hud.hudactionlog
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/recordrequest
      name: json-hud-action-recordrequest
      description: REST surface for JSON-hud-action-recordRequest.
      operations:
      - method: GET
        name: hudactionrecordrequest
        description: Used by the HUD to cache a request the user wants to send in the browser
        call: owasp-zap-hud.hudactionrecordrequest
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/resettutorialtasks
      name: json-hud-action-resettutorialtasks
      description: REST surface for JSON-hud-action-resetTutorialTasks.
      operations:
      - method: GET
        name: hudactionresettutorialtasks
        description: Reset the tutorial tasks so that they must be completed again
        call: owasp-zap-hud.hudactionresettutorialtasks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptionbasedirectory
      name: json-hud-action-setoptionbasedirectory
      description: REST surface for JSON-hud-action-setOptionBaseDirectory.
      operations:
      - method: GET
        name: hudactionsetoptionbasedirectory
        description: Set the base directory from which the HUD files are loaded
        call: owasp-zap-hud.hudactionsetoptionbasedirectory
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptiondevelopmentmode
      name: json-hud-action-setoptiondevelopmentmode
      description: REST surface for JSON-hud-action-setOptionDevelopmentMode.
      operations:
      - method: GET
        name: hudactionsetoptiondevelopmentmode
        description: Sets the boolean option 'Development mode'
        call: owasp-zap-hud.hudactionsetoptiondevelopmentmode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptionenableondomainmsgs
      name: json-hud-action-setoptionenableondomainmsgs
      description: REST surface for JSON-hud-action-setOptionEnableOnDomainMsgs.
      operations:
      - method: GET
        name: hudactionsetoptionenableondomainmsgs
        description: hudactionsetoptionenableondomainmsgs
        call: owasp-zap-hud.hudactionsetoptionenableondomainmsgs
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptionenabledfordaemon
      name: json-hud-action-setoptionenabledfordaemon
      description: REST surface for JSON-hud-action-setOptionEnabledForDaemon.
      operations:
      - method: GET
        name: hudactionsetoptionenabledfordaemon
        description: hudactionsetoptionenabledfordaemon
        call: owasp-zap-hud.hudactionsetoptionenabledfordaemon
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptionenabledfordesktop
      name: json-hud-action-setoptionenabledfordesktop
      description: REST surface for JSON-hud-action-setOptionEnabledForDesktop.
      operations:
      - method: GET
        name: hudactionsetoptionenabledfordesktop
        description: hudactionsetoptionenabledfordesktop
        call: owasp-zap-hud.hudactionsetoptionenabledfordesktop
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptioninscopeonly
      name: json-hud-action-setoptioninscopeonly
      description: REST surface for JSON-hud-action-setOptionInScopeOnly.
      operations:
      - method: GET
        name: hudactionsetoptioninscopeonly
        description: Sets the boolean option 'In scope only'
        call: owasp-zap-hud.hudactionsetoptioninscopeonly
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptionremovecsp
      name: json-hud-action-setoptionremovecsp
      description: REST surface for JSON-hud-action-setOptionRemoveCSP.
      operations:
      - method: GET
        name: hudactionsetoptionremovecsp
        description: Sets the boolean option 'Remove CSP'
        call: owasp-zap-hud.hudactionsetoptionremovecsp
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptionshowwelcomescreen
      name: json-hud-action-setoptionshowwelcomescreen
      description: REST surface for JSON-hud-action-setOptionShowWelcomeScreen.
      operations:
      - method: GET
        name: hudactionsetoptionshowwelcomescreen
        description: hudactionsetoptionshowwelcomescreen
        call: owasp-zap-hud.hudactionsetoptionshowwelcomescreen
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptionskiptutorialtasks
      name: json-hud-action-setoptionskiptutorialtasks
      description: REST surface for JSON-hud-action-setOptionSkipTutorialTasks.
      operations:
      - method: GET
        name: hudactionsetoptionskiptutorialtasks
        description: hudactionsetoptionskiptutorialtasks
        call: owasp-zap-hud.hudactionsetoptionskiptutorialtasks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptiontutorialtaskdone
      name: json-hud-action-setoptiontutorialtaskdone
      description: REST surface for JSON-hud-action-setOptionTutorialTaskDone.
      operations:
      - method: GET
        name: hudactionsetoptiontutorialtaskdone
        description: hudactionsetoptiontutorialtaskdone
        call: owasp-zap-hud.hudactionsetoptiontutorialtaskdone
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setoptiontutorialtestmode
      name: json-hud-action-setoptiontutorialtestmode
      description: REST surface for JSON-hud-action-setOptionTutorialTestMode.
      operations:
      - method: GET
        name: hudactionsetoptiontutorialtestmode
        description: hudactionsetoptiontutorialtestmode
        call: owasp-zap-hud.hudactionsetoptiontutorialtestmode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/action/setuioption
      name: json-hud-action-setuioption
      description: REST surface for JSON-hud-action-setUiOption.
      operations:
      - method: GET
        name: hudactionsetuioption
        description: Sets a UI option with the given key and value. The key must be 50 or fewer alphanumeric characters
        call: owasp-zap-hud.hudactionsetuioption
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/getuioption
      name: json-hud-view-getuioption
      description: REST surface for JSON-hud-view-getUiOption.
      operations:
      - method: GET
        name: hudviewgetuioption
        description: Gets a UI option set using setUiOption. If the supplied key is not set then an empty string is returned
        call: owasp-zap-hud.hudviewgetuioption
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/heartbeat
      name: json-hud-view-heartbeat
      description: REST surface for JSON-hud-view-heartbeat.
      operations:
      - method: GET
        name: hudviewheartbeat
        description: Used by service workers to keep alive
        call: owasp-zap-hud.hudviewheartbeat
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/hudalertdata
      name: json-hud-view-hudalertdata
      description: REST surface for JSON-hud-view-hudAlertData.
      operations:
      - method: GET
        name: hudviewhudalertdata
        description: Returns the alert summary needed by the HUD for the specified URL
        call: owasp-zap-hud.hudviewhudalertdata
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionallowunsafeeval
      name: json-hud-view-optionallowunsafeeval
      description: REST surface for JSON-hud-view-optionAllowUnsafeEval.
      operations:
      - method: GET
        name: hudviewoptionallowunsafeeval
        description: Returns true if the 'Allow unsafe-eval' option is set
        call: owasp-zap-hud.hudviewoptionallowunsafeeval
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionbasedirectory
      name: json-hud-view-optionbasedirectory
      description: REST surface for JSON-hud-view-optionBaseDirectory.
      operations:
      - method: GET
        name: hudviewoptionbasedirectory
        description: Returns the base directory from which the HUD files are loaded
        call: owasp-zap-hud.hudviewoptionbasedirectory
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optiondevelopmentmode
      name: json-hud-view-optiondevelopmentmode
      description: REST surface for JSON-hud-view-optionDevelopmentMode.
      operations:
      - method: GET
        name: hudviewoptiondevelopmentmode
        description: Returns true if the 'Development mode' option is set
        call: owasp-zap-hud.hudviewoptiondevelopmentmode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionenableondomainmsgs
      name: json-hud-view-optionenableondomainmsgs
      description: REST surface for JSON-hud-view-optionEnableOnDomainMsgs.
      operations:
      - method: GET
        name: hudviewoptionenableondomainmsgs
        description: hudviewoptionenableondomainmsgs
        call: owasp-zap-hud.hudviewoptionenableondomainmsgs
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionenabletelemetry
      name: json-hud-view-optionenabletelemetry
      description: REST surface for JSON-hud-view-optionEnableTelemetry.
      operations:
      - method: GET
        name: hudviewoptionenabletelemetry
        description: hudviewoptionenabletelemetry
        call: owasp-zap-hud.hudviewoptionenabletelemetry
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionenabledfordaemon
      name: json-hud-view-optionenabledfordaemon
      description: REST surface for JSON-hud-view-optionEnabledForDaemon.
      operations:
      - method: GET
        name: hudviewoptionenabledfordaemon
        description: hudviewoptionenabledfordaemon
        call: owasp-zap-hud.hudviewoptionenabledfordaemon
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionenabledfordesktop
      name: json-hud-view-optionenabledfordesktop
      description: REST surface for JSON-hud-view-optionEnabledForDesktop.
      operations:
      - method: GET
        name: hudviewoptionenabledfordesktop
        description: hudviewoptionenabledfordesktop
        call: owasp-zap-hud.hudviewoptionenabledfordesktop
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optioninscopeonly
      name: json-hud-view-optioninscopeonly
      description: REST surface for JSON-hud-view-optionInScopeOnly.
      operations:
      - method: GET
        name: hudviewoptioninscopeonly
        description: Returns true if the 'In scope only' option is set
        call: owasp-zap-hud.hudviewoptioninscopeonly
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionremovecsp
      name: json-hud-view-optionremovecsp
      description: REST surface for JSON-hud-view-optionRemoveCSP.
      operations:
      - method: GET
        name: hudviewoptionremovecsp
        description: Returns true if the 'Remove CSP' option is set
        call: owasp-zap-hud.hudviewoptionremovecsp
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionshowwelcomescreen
      name: json-hud-view-optionshowwelcomescreen
      description: REST surface for JSON-hud-view-optionShowWelcomeScreen.
      operations:
      - method: GET
        name: hudviewoptionshowwelcomescreen
        description: hudviewoptionshowwelcomescreen
        call: owasp-zap-hud.hudviewoptionshowwelcomescreen
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optionskiptutorialtasks
      name: json-hud-view-optionskiptutorialtasks
      description: REST surface for JSON-hud-view-optionSkipTutorialTasks.
      operations:
      - method: GET
        name: hudviewoptionskiptutorialtasks
        description: hudviewoptionskiptutorialtasks
        call: owasp-zap-hud.hudviewoptionskiptutorialtasks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optiontutorialhost
      name: json-hud-view-optiontutorialhost
      description: REST surface for JSON-hud-view-optionTutorialHost.
      operations:
      - method: GET
        name: hudviewoptiontutorialhost
        description: hudviewoptiontutorialhost
        call: owasp-zap-hud.hudviewoptiontutorialhost
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optiontutorialport
      name: json-hud-view-optiontutorialport
      description: REST surface for JSON-hud-view-optionTutorialPort.
      operations:
      - method: GET
        name: hudviewoptiontutorialport
        description: hudviewoptiontutorialport
        call: owasp-zap-hud.hudviewoptiontutorialport
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optiontutorialtasksdone
      name: json-hud-view-optiontutorialtasksdone
      description: REST surface for JSON-hud-view-optionTutorialTasksDone.
      operations:
      - method: GET
        name: hudviewoptiontutorialtasksdone
        description: hudviewoptiontutorialtasksdone
        call: owasp-zap-hud.hudviewoptiontutorialtasksdone
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optiontutorialtestmode
      name: json-hud-view-optiontutorialtestmode
      description: REST surface for JSON-hud-view-optionTutorialTestMode.
      operations:
      - method: GET
        name: hudviewoptiontutorialtestmode
        description: hudviewoptiontutorialtestmode
        call: owasp-zap-hud.hudviewoptiontutorialtestmode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/optiontutorialupdates
      name: json-hud-view-optiontutorialupdates
      description: REST surface for JSON-hud-view-optionTutorialUpdates.
      operations:
      - method: GET
        name: hudviewoptiontutorialupdates
        description: hudviewoptiontutorialupdates
        call: owasp-zap-hud.hudviewoptiontutorialupdates
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/tutorialupdates
      name: json-hud-view-tutorialupdates
      description: REST surface for JSON-hud-view-tutorialUpdates.
      operations:
      - method: GET
        name: hudviewtutorialupdates
        description: hudviewtutorialupdates
        call: owasp-zap-hud.hudviewtutorialupdates
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/json/hud/view/upgradeddomains
      name: json-hud-view-upgradeddomains
      description: REST surface for JSON-hud-view-upgradedDomains.
      operations:
      - method: GET
        name: hudviewupgradeddomains
        description: hudviewupgradeddomains
        call: owasp-zap-hud.hudviewupgradeddomains
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/other/hud/other/changesinhtml
      name: other-hud-other-changesinhtml
      description: REST surface for OTHER-hud-other-changesInHtml.
      operations:
      - method: GET
        name: hudotherchangesinhtml
        description: Returns the changelog in HTML format
        call: owasp-zap-hud.hudotherchangesinhtml
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: owasp-zap-hud-mcp
    port: 9090
    transport: http
    description: MCP adapter for ZAP API — hud. One tool per consumed operation, routed inline through this capability's consumes
      block.
    tools:
    - name: used-hud-log-messages-browser
      description: Used by the HUD to log messages from the browser
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-hud.hudactionlog
      outputParameters:
      - type: object
        mapping: $.
    - name: used-hud-cache-request-user
      description: Used by the HUD to cache a request the user wants to send in the browser
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-hud.hudactionrecordrequest
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-tutorial-tasks-so-that
      description: Reset the tutorial tasks so that they must be completed again
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-hud.hudactionresettutorialtasks
      outputParameters:
      - type: object
        mapping: $.
    - name: set-base-directory-which-hud
      description: Set the base directory from which the HUD files are loaded
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-hud.hudactionsetoptionbasedirectory
      outputParameters:
      - type: object
        mapping: $.
    - name: sets-boolean-option-development-mode
      description: Sets the boolean option 'Development mode'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-hud.hudactionsetoptiondevelopmentmode
      outputParameters:
      - type: object
        mapping: $.
    - name: hudactionsetoptionenableondomainmsgs
      description: hudactionsetoptionenableondomainmsgs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-hud.hudactionsetoptionenableondomainmsgs
      outputParameters:
      - type: object
        mapping: $.
    - name: hudactionsetoptionenabledfordaemon
      description: hudactionsetoptionenabledfordaemon
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: owasp-zap-hud.hudactionsetoptionenabledfordaemon
      outputParameters:
      - type: object
        mapping: $.
    - name: hudactionsetoptionenabledfordesktop
      description: hudactionsetoptionenabledfordesktop
      hints:
        readOnly: true
        destructive: false

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/owasp-zap/refs/heads/main/capabilities/owasp-zap-hud.yaml