action.yml

name: 'OWASP ZAP API Scan'
description: 'Scans the web application with the OWASP ZAP API Scan'
branding:
  icon: 'zap'
  color: 'blue'
inputs:
  token:
    description: 'GitHub Token to create issues in the repository'
    required: false
    default: ${{ github.token }}
  api_definition:
    description: 'Target API definition'
    required: true
  format:
    description: 'API definition format: {openapi, soap, graphql}'
    required: true
  docker_name:
    description: 'The Docker file to be executed'
    required: true
    default: 'owasp/zap2docker-stable'
  cmd_options:
    description: 'Additional command line options'
    required: false
  issue_title:
    description: 'The title for the GitHub issue to be created'
    required: false
    default: 'ZAP API Scan Report'
  fail_action:
    description: 'The action status will be set to fail if ZAP identifies any alerts during the full scan'
    required: false
    default: false
runs:
  using: 'node12'
  main: 'dist/index.js'