Skip to content

Commit

Permalink
Reorder alphabetically and rephrase a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
@Drarig29
Drarig29 committed Jun 14, 2023
1 parent 155a502 commit 2aec1f7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/commands/synthetics/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ The duration (in milliseconds) after which `datadog-ci` stops polling for test r
`subdomain`
: The name of the custom subdomain set to access your Datadog application. If the URL used to access Datadog is `myorg.datadoghq.com`, the `subdomain` value needs to be set to `myorg`.

`tunnel`
: Use the [Continuous Testing Tunnel](#use-the-testing-tunnel) to execute your test batch.

`testSearchQuery`
: Pass a query to select which Synthetic tests to run. If you are running tests in the CLI, use the `-s` flag.

`tunnel`
: Use the [Continuous Testing Tunnel](#use-the-testing-tunnel) to execute your test batch.

#### Use a proxy

It is possible to configure a proxy to be used for outgoing connections to Datadog using the `proxy` key of the global configuration file.
Expand All @@ -116,10 +116,10 @@ For example:
"apiKey": "<DATADOG_API_KEY>",
"appKey": "<DATADOG_APPLICATION_KEY>",
"datadogSite": "datadoghq.com", // You can use another Datadog site in https://docs.datadoghq.com/getting_started/site/. By default, requests are sent to Datadog US1.
"files": ["{,!(node_modules)/**/}*.synthetics.json"],
"failOnCriticalErrors": false,
"failOnMissingTests": false,
"failOnTimeout": true,
"files": ["{,!(node_modules)/**/}*.synthetics.json"],
"global": {
"allowInsecureCertificates": true,
"basicAuth": {"username": "test", "password": "test"},
Expand Down Expand Up @@ -323,8 +323,8 @@ All options under the `config` key are optional and allow overriding of the test
| `allowInsecureCertificates` | Boolean | Disable certificate checks in Synthetic API tests. |
| `basicAuth` | Object | Credentials to provide if basic authentication is required.<br><br>- `username` (String): The username for basic authentication.<br>- `password` (String): The password for basic authentication. |
| `body` | String | Data to send in an API test. |
| `bodyType` | String | Type of data sent in an API test. |
| `cookies` | String or object | Use the provided string as a cookie header in an API or browser test (in addition or as a replacement).<br><br>- If this is a string, it is used to replace the original cookies.<br>- If this is an object, the format must be `{append?: boolean, value: string}`, and depending on the value of the `append`, it is appended or replaces the original cookies. |
| `bodyType` | String | Content type for the data to send in an API test. |
| `cookies` | String or object | Use the provided string as a cookie header in an API or browser test (in addition or as a replacement).<br><br>- If this is a string, it is used to replace the original cookies.<br>- If this is an object, the format must be `{append?: boolean, value: string}`, and depending on the value of `append`, it is appended or replaces the original cookies. |
| `defaultStepTimeout` | Number | The maximum duration of steps in seconds for browser tests, which does not override individually set step timeouts. |
| `deviceIds` | Array | A list of devices to run the browser test on. |
| `executionRule` | String | The execution rule for the test defines the behavior of the CLI in case of a failing test.<br><br>- `blocking`: The CLI returns an error if the test fails.<br>- `non_blocking`: The CLI only prints a warning if the test fails.<br>- `skipped`: The test is not executed at all. |
Expand Down

0 comments on commit 2aec1f7

Please sign in to comment.