Skip to content

Commit

Permalink
mayhem-url documentation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Ross-ForAllSecure committed May 3, 2024
1 parent c73c0a6 commit 0f604bd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The action accepts the follow inputs:

| Required | Input Name | Type | Description | Default
| --- | --- | --- | --- | ---
| ✔️ | `mayhem-url` | string | Mayhem URL | https://app.mayhem.security
| | `mayhem-url` | string | Path to your Mayhem API. | https://app.mayhem.security
| ✔️ | `mayhem-token` | string | Mayhem API token |
| ✔️ | `api-url` | string | URL to your running API. *Example:* http://localhost:8000/api/v1 |
| ✔️ | `api-spec` | string | Path or URL to your Swagger spec, OpenAPI spec, or Postman collection file, or Postman [collection id](https://support.postman.com/hc/en-us/articles/5063785095319-How-to-find-the-ID-of-an-element-in-Postman).|
Expand All @@ -93,7 +93,7 @@ The action accepts the follow inputs:
| | `html-report` | string | Path to the generated SARIF report |
| | `sarif-report` | string | Path to the generated HTML report |
| | `run-args` | string | Additional arguments to provide to the `mapi run` command. Argument values should be separated on new lines. <br><br>e.g.<br> <pre> run-args: \|<br> # Basic Auth<br> --basic-auth<br> login:password</pre><br>⚠️ Avoid wrapping values in quotes, as these will be escaped and included in the value passed to `mapi`.<br><br>⛔️ `"login:password"` <br>✅ `login:password` |
| | `mayhem-url` | string | Path to your Mayhem API instance. If you're using something other than the default of https://app.mayhem.security |


### Continuing on error

Expand Down

0 comments on commit 0f604bd

Please sign in to comment.