Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

Commit b027419

Browse files
committed
fix: small changes requested by reviewers
1 parent a4010de commit b027419

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed
-22 KB
Loading

site/content/docs/api-checks/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ Ensure your API is working properly with API checks. API checks work by sending
1717

1818
![Screenshot of the API check overview page](/docs/images/api-checks/overview-check-overview.png)
1919

20-
You can use these checks to verify that:
20+
For example, you can use these checks to verify that:
2121
* Your endpoint returns a 200 status code.
2222
* Your endpoint responds with valid JSON that matches the expected schema.
2323
* Your endpoint is properly authenticating requests.
2424

25-
If your endpoint is unresponsive or fails assertions, the check will trigger any configured alerts.
25+
If your endpoint is unresponsive or fails assertions, the check will trigger any configured [alerts](/docs/alerting-and-retries/).
2626

2727
## Creating an API check
2828

@@ -51,7 +51,7 @@ Setup scripts allow you to do last minute processing of test data and request op
5151

5252
### Response time limits
5353

54-
Sometimes APIs can be slow, but not broken. We call this **degraded**. You can set [response time limits](/docs/api-checks/limits/) to specify when an API check should be marked as **degraded** and when it should be marked as **failed**.
54+
Sometimes APIs can be slow, but not broken. We call this degraded. You can set [response time limits](/docs/api-checks/limits/) to specify when an API check should be marked as degraded and when it should be marked as failed.
5555

5656
### Assertions
5757

@@ -105,7 +105,7 @@ new ApiCheck('hello-api-1', {
105105

106106
The above example defines:
107107
- The basic check properties like `name`, `activated` etc.
108-
- The HTTP method `GET` the `url`.
108+
- The `GET` HTTP method and target `url` of the request.
109109
- An array of assertions to assert the HTTP response status is correct.
110110

111111
For more options, see the [Check construct reference](/docs/cli/constructs-reference/#check).

0 commit comments

Comments
 (0)