Merge branch 'main' into nahuelon/gh-736/add-private-location-construct

checkly · Jun 20, 2023 · bfaeac4 · bfaeac4
2 parents 66ca8bd + 7c159c0
commit bfaeac4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/packages/cli/src/constructs/dashboard.ts b/packages/cli/src/constructs/dashboard.ts
@@ -137,6 +137,8 @@ export class Dashboard extends Construct {
  *
  * @param logicalId unique project-scoped resource name identification
  * @param props dashboard configuration properties
+ *
+ * {@link https://checklyhq.com/docs/cli/constructs/#dashboard Read more in the docs}
  */
  constructor (logicalId: string, props: DashboardProps) {
  super(Dashboard.__checklyType, logicalId)

diff --git a/packages/cli/src/constructs/maintenance-window.ts b/packages/cli/src/constructs/maintenance-window.ts
@@ -13,23 +13,25 @@ export interface MaintenanceWindowProps {
  */
  tags: Array<string>,
  /**
- * The start date of the maintenance window.
+ * The start date and time of the maintenance window in ISO 8601 format, "YYYY-MM-DDTHH:mm:ss.sssZ" as returned by
+ * `new Date()`
  */
  startsAt: Date
  /**
- * The end date of the maintenance window.
+ * The end date and time of the maintenance window in ISO 8601 format, "YYYY-MM-DDTHH:mm:ss.sssZ" as returned by
+ * `new Date()`
  */
  endsAt: Date
  /**
- * The repeat interval of the maintenance window from the first occurance.
+ * The repeat interval of the maintenance window from the first occurrence.
  */
  repeatInterval?: number
  /**
  * The repeat strategy for the maintenance window. This is mandatory when you specify a repeat interval.
  */
  repeatUnit?: MaintenanceWindowRepeatUnit
  /**
- * The end date where the maintenance window should stop repeating.
+ * The end date and time when the maintenance window should stop repeating.
  */
  repeatEndsAt?: Date
 }
@@ -57,6 +59,8 @@ export class MaintenanceWindow extends Construct {
  *
  * @param logicalId unique project-scoped resource name identification
  * @param props maintenance window configuration properties
+ *
+ * {@link https://checklyhq.com/docs/cli/constructs/#maintenancewindow Read more in the docs}
  */
  constructor (logicalId: string, props: MaintenanceWindowProps) {
  super(MaintenanceWindow.__checklyType, logicalId)