Skip to content
GitLab
Next
Closed
Issue created by Michael Eddington@mikeeddingtonDeveloper4 of 4 checklist items completed4/4 checklist items

Improve messages around Session starting

Problem

When a user is configuring API Fuzzing having clear log messages helps the user understand what is happening. Recently there has been confusion around the start session related messages.

  1. Message with (1/120) but we don't say what it means (retry logic)
  2. We don't provide a success message
  3. If user points to a different endpoint we say "version header wasn't found" as an error message. We should provide a more descriptive message.

Proposal

  1. Change starting message to: Starting API Security scanner session (Try 1/120)
  2. Provide a success message: Successfully started API Security scanner session
  3. Change error message for API Security version header not found to (work in progress):
    1. Warning, failed to start API Security session. Please verify FUZZAPI_API has not been changed. The FUZZAPI_API endpoint didn't provide a API Security version header.
  4. Add a troubleshooting section to the documentation and add this error message with a longer discussion about what caused it and how it can be fixed.
Edited by Herber Madrigal