Skip to content

Commit 4dde546

Browse files
stefanjudisstefanjudis
committed
fix: update tsdoc reference docs urls
1 parent 40d0bae commit 4dde546

29 files changed

+55
-106
lines changed

‎packages/cli/src/constructs/alert-channel.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,7 @@ export class AlertChannelRef extends Construct {
116116
* sslExpiryThreshold: 7 // Alert 7 days before SSL expiry
117117
* })
118118
* ```
119-
*
120-
* @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#alertchannel | AlertChannel API Reference}
121-
* @see {@link https://www.checklyhq.com/docs/alerting-and-retries/alert-channels/ | Alert Channels Documentation}
119+
* @see {@link https://www.checklyhq.com/docs/communicate/alerts/channels/ | Alert Channels Documentation}
122120
*/
123121
export abstract class AlertChannel extends Construct {
124122
sendRecovery?: boolean

‎packages/cli/src/constructs/api-assertion.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export type Assertion = CoreAssertion<ApiAssertionSource>
4949
* ```
5050
*
5151
* @see {@link https://jsonpath.com/ | JSONPath Online Evaluator}
52-
* @see {@link https://www.checklyhq.com/docs/api-checks/assertions/ | API Check Assertions}
52+
* @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/assertions/ | API Check Assertions}
5353
*/
5454
// Called AssertionBuilder instead of ApiAssertionBuilder for historical
5555
// reasons.

‎packages/cli/src/constructs/api-check.ts‎

Lines changed: 4 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -136,66 +136,9 @@ export interface ApiCheckProps extends RuntimeCheckProps {
136136
* })
137137
* ```
138138
*
139-
* @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#apicheck | ApiCheck API Reference}
140-
* @see {@link https://www.checklyhq.com/docs/monitoring/api-checks/ | API Checks Documentation}
141-
*/
142-
/**
143-
* Creates an API Check to monitor HTTP endpoints and APIs.
144-
*
145-
* API checks allow you to monitor REST APIs, GraphQL endpoints, and any HTTP-based service.
146-
* You can validate response status codes, response times, headers, and response body content.
147-
*
148-
* @example
149-
* ```typescript
150-
* // Basic API check
151-
* new ApiCheck('hello-api', {
152-
* name: 'Hello API',
153-
* request: {
154-
* method: 'GET',
155-
* url: 'https://api.example.com/hello',
156-
* assertions: [
157-
* AssertionBuilder.statusCode().equals(200)
158-
* ]
159-
* }
160-
* })
161-
*
162-
* // Advanced API check with POST request
163-
* new ApiCheck('user-api', {
164-
* name: 'User API Check',
165-
* frequency: Frequency.EVERY_5M,
166-
* locations: ['us-east-1', 'eu-west-1'],
167-
* request: {
168-
* method: 'POST',
169-
* url: 'https://api.example.com/users',
170-
* headers: [{ key: 'Content-Type', value: 'application/json' }],
171-
* body: JSON.stringify({ name: 'test-user' }),
172-
* bodyType: 'JSON',
173-
* assertions: [
174-
* AssertionBuilder.statusCode().equals(201),
175-
* AssertionBuilder.jsonBody('$.id').isNotNull(),
176-
* AssertionBuilder.responseTime().lessThan(1000)
177-
* ]
178-
* },
179-
* maxResponseTime: 5000,
180-
* degradedResponseTime: 2000
181-
* })
182-
*
183-
* // Error validation check (shouldFail required for error status checks)
184-
* new ApiCheck('not-found-check', {
185-
* name: 'Not Found Check',
186-
* shouldFail: true,
187-
* request: {
188-
* method: 'GET',
189-
* url: 'https://api.example.com/nonexistent',
190-
* assertions: [
191-
* AssertionBuilder.statusCode().equals(404)
192-
* ]
193-
* }
194-
* })
195-
* ```
196-
*
197-
* @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#apicheck | ApiCheck API Reference}
198-
* @see {@link https://www.checklyhq.com/docs/monitoring/api-checks/ | API Checks Documentation}
139+
* @see {@link https://www.checklyhq.com/docs/constructs/api-check/ | ApiCheck API Reference}
140+
* @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/overview/
141+
* API Checks Documentation}
199142
*/
200143
export class ApiCheck extends RuntimeCheck {
201144
readonly request: Request
@@ -212,7 +155,7 @@ export class ApiCheck extends RuntimeCheck {
212155
* @param logicalId unique project-scoped resource name identification
213156
* @param props check configuration properties
214157
*
215-
* {@link https://checklyhq.com/docs/cli/constructs-reference/#apicheck Read more in the docs}
158+
* {@link https://www.checklyhq.com/docs/constructs/api-check/ Read more in the docs}
216159
*/
217160

218161
constructor (logicalId: string, props: ApiCheckProps) {

‎packages/cli/src/constructs/browser-check.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,9 @@ export interface BrowserCheckProps extends RuntimeCheckProps {
7272
* })
7373
* ```
7474
*
75-
* @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#browsercheck | BrowserCheck API Reference}
76-
* @see {@link https://www.checklyhq.com/docs/monitoring/browser-checks/ | Browser Checks Documentation}
75+
* @see {@link https://www.checklyhq.com/docs/constructs/browser-check/ | BrowserCheck API Reference}
76+
* @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview/
77+
* Browser Checks Documentation}
7778
* @see {@link https://playwright.dev/ | Playwright Documentation}
7879
*/
7980
export class BrowserCheck extends RuntimeCheck {
@@ -86,7 +87,7 @@ export class BrowserCheck extends RuntimeCheck {
8687
*
8788
* @param logicalId unique project-scoped resource name identification
8889
* @param props check configuration properties
89-
* {@link https://checklyhq.com/docs/cli/constructs-reference/#browsercheck Read more in the docs}
90+
* {@link https://www.checklyhq.com/docs/constructs/browser-check/ Read more in the docs}
9091
*/
9192
constructor (logicalId: string, props: BrowserCheckProps) {
9293
super(logicalId, props)

‎packages/cli/src/constructs/check-group-v2.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ export interface CheckGroupV2Props extends Omit<CheckGroupV1Props, 'alertEscalat
8686
*
8787
* If not set, individual check settings are used.
8888
*
89-
* See https://www.checklyhq.com/docs/monitoring/global-locations/ to learn
89+
* See https://www.checklyhq.com/docs/concepts/locations/ to learn
9090
* more about scheduling strategies.
9191
*/
9292
runParallel?: boolean

‎packages/cli/src/constructs/check.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export interface CheckProps {
9393
* An array of one or more data center locations where to run this check.
9494
*
9595
* @example ['us-east-1', 'eu-west-1', 'ap-southeast-1']
96-
* @see {@link https://www.checklyhq.com/docs/monitoring/global-locations/ | Global Locations}
96+
* @see {@link https://www.checklyhq.com/docs/concepts/locations/ | Global Locations}
9797
*/
9898
locations?: Array<keyof Region>
9999

@@ -174,7 +174,7 @@ export interface CheckProps {
174174
* // Reference the channels in your check
175175
* alertChannels: [emailChannel, slackChannel]
176176
* ```
177-
* @see {@link https://www.checklyhq.com/docs/alerting-and-retries/alert-channels/ | Alert Channels}
177+
* @see {@link https://www.checklyhq.com/docs/communicate/alerts/channels/ | Alert Channels}
178178
*/
179179
alertChannels?: Array<AlertChannel | AlertChannelRef>
180180

@@ -218,15 +218,16 @@ export interface CheckProps {
218218
* Determines whether the check should run on all selected locations in parallel or round-robin.
219219
*
220220
* @defaultValue false (round-robin)
221-
* @see {@link https://www.checklyhq.com/docs/monitoring/global-locations/ | Scheduling Strategies}
221+
* @see {@link https://www.checklyhq.com/docs/concepts/scheduling/ | Scheduling Strategies}
222222
*/
223223
runParallel?: boolean
224224

225225
/**
226226
* Determines whether the check should create and resolve an incident based on its alert configuration.
227227
* Useful for status page automation.
228228
*
229-
* @see {@link https://www.checklyhq.com/docs/status-pages/incidents/#incident-automation | Incident Automation}
229+
* @see {@link https://www.checklyhq.com/docs/communicate/status-pages/incidents/#incident-automation
230+
* Incident Automation}
230231
*/
231232
triggerIncident?: IncidentTrigger
232233
}

‎packages/cli/src/constructs/dashboard.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ export interface DashboardProps {
4545
* This is required if 'customUrl' is not specified.
4646
*
4747
* @example 'status.example.com'
48-
* @see {@link https://www.checklyhq.com/docs/dashboards/custom-domains/ | Custom Domain Setup}
48+
* @see {@link https://www.checklyhq.com/docs/communicate/dashboards/configuration/#custom-domain
49+
* Custom Domain Setup}
4950
*/
5051
customDomain?: string
5152

@@ -144,7 +145,7 @@ export interface DashboardProps {
144145
*
145146
* @defaultValue false
146147
* @remarks Only paid accounts can enable this feature
147-
* @see {@link https://www.checklyhq.com/docs/dashboards/incidents/ | Dashboard Incidents}
148+
* @see {@link https://www.checklyhq.com/docs/communicate/dashboards/incidents/ | Dashboard Incidents}
148149
*/
149150
enableIncidents?: boolean
150151

@@ -244,7 +245,7 @@ export class Dashboard extends Construct {
244245
* @param logicalId unique project-scoped resource name identification
245246
* @param props dashboard configuration properties
246247
*
247-
* {@link https://checklyhq.com/docs/cli/constructs-reference/#dashboard Read more in the docs}
248+
* {@link https://www.checklyhq.com/docs/constructs/dashboard/ Read more in the docs}
248249
*/
249250
constructor (logicalId: string, props: DashboardProps) {
250251
super(Dashboard.__checklyType, logicalId)

‎packages/cli/src/constructs/dns-monitor.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export class DnsMonitor extends Monitor {
5858
* @param logicalId unique project-scoped resource name identification
5959
* @param props configuration properties
6060
*
61-
* {@link https://checklyhq.com/docs/cli/constructs-reference/#dnsmonitor Read more in the docs}
61+
* {@link https://www.checklyhq.com/docs/constructs/dns-monitor/ Read more in the docs}
6262
*/
6363

6464
constructor (logicalId: string, props: DnsMonitorProps) {

‎packages/cli/src/constructs/email-alert-channel.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export class EmailAlertChannel extends AlertChannel {
2222
*
2323
* @param logicalId unique project-scoped resource name identification
2424
* @param props email alert channel configuration properties
25-
* {@link https://checklyhq.com/docs/cli/constructs-reference/#emailalertchannel Read more in the docs}
25+
* {@link https://www.checklyhq.com/docs/constructs/email-alert-channel/ Read more in the docs}
2626
*/
2727
constructor (logicalId: string, props: EmailAlertChannelProps) {
2828
super(logicalId, props)

‎packages/cli/src/constructs/frequency.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* frequency: Frequency.EVERY_24H
1515
* ```
1616
*
17-
* @see {@link https://www.checklyhq.com/docs/monitoring/ | Monitoring Documentation}
17+
* @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/overview/ | Monitoring Documentation}
1818
*/
1919
export class Frequency {
2020
/** Run every 10 seconds */

0 commit comments

Comments
 (0)