From 5cf7c22bd8c8473cc7f42854bac9c42265010217 Mon Sep 17 00:00:00 2001 From: Madalin Ilie Date: Fri, 24 Jan 2025 17:57:37 +0200 Subject: [PATCH] docs: Add missing arguments in documentation --- docs/commands-and-arguments/arguments.md | 2 ++ docs/commands-and-arguments/sub-commands.md | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/commands-and-arguments/arguments.md b/docs/commands-and-arguments/arguments.md index e7feb6a5d..1d4f7b11b 100644 --- a/docs/commands-and-arguments/arguments.md +++ b/docs/commands-and-arguments/arguments.md @@ -105,6 +105,8 @@ You can get the full list of arguments by running `cats -h`. Below is a short de - `--stopAfterErrors=` Number of errors after which the continuous fuzzing will stop running. Errors are defined as conditions matching the given match arguments. Only available in `cats random` sub-command. - `--stopAfterMutations=` Number of mutations (test cases) after which the continuous fuzzing will stop running. Only available in `cats random` sub-command. - `--stopAfterTimeInSec=` Amount of time in seconds for how long the continuous fuzzing will run before stopping. Only available in `cats random` sub-command. +- `--pathsRunOrder=` A file with the order in which the paths will be executed. The paths are on each line. The order from file will drive the execution order +- `--errorLeaksKeywords=` A properties file with error leaks keywords that will be used when processing responses to detect potential error leaks. If one of these keyword is found, the test case will be marked as error :::tip When you want to skip fuzzing entirely for a specific JSON object or specific fields you must prefix the field name from the `--skipFields` argument with `!`. diff --git a/docs/commands-and-arguments/sub-commands.md b/docs/commands-and-arguments/sub-commands.md index cda0e21bb..230204e4d 100644 --- a/docs/commands-and-arguments/sub-commands.md +++ b/docs/commands-and-arguments/sub-commands.md @@ -27,7 +27,7 @@ All available subcommands are listed below: - `cats replay "test1,test2"` will replay the given tests `test1` and `test2` -- `cats fuzz` will fuzz based on a given request template, rather than an OpenAPI contract +- `cats template` will fuzz based on a given request template, rather than an OpenAPI contract - `cats run` will run functional and targeted security tests written in the CATS YAML format @@ -41,6 +41,7 @@ All available subcommands are listed below: - `cats random` does continuous fuzzing based on mutators until a certain stop condition is hit + :::tip Each sub-command has its own help. You can run `cats sub-command -h` to check all available arguments: `cats fuzz -h`. ::: \ No newline at end of file