Skip to content

Document Exclude parameter in API Security

Herber Madrigal requested to merge 292196-document-exclude-parameter into master

What does this MR do?

Document new feature to exclude parameters in API Security. As part of the API fuzzing and DAST API scan process, parameters are used to look for vulnerabilities. There might be scenarios where specific parameters should not be tested because vulnerabilities are false positives or these parameters might always fail.

This MR documents how the user can instruct API Fuzzing and DAST API to exclude specific parameters.

Related issues

Author's checklist

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports