@oneuptime/common 14.0.13 → 14.0.14

package/Models/DatabaseModels/AlertGroupingRule.ts

@@ -1373,7 +1373,8 @@ export default class AlertGroupingRule extends RuleBaseModel {
     type: TableColumnType.Entity,
     modelType: User,
     title: "Default Assign To User",
-    description: "Default user to assign episodes created by this rule",
+    description:
+      "Kept for API compatibility: copied to the assignedToUser of each episode this rule opens while the user is a member of the project. OneUptime does not show it anywhere; to make someone responsible for those episodes, use episodeOwnerUsers.",
   })
   @ManyToOne(
     () => {
@@ -1416,7 +1417,8 @@ export default class AlertGroupingRule extends RuleBaseModel {
     type: TableColumnType.ObjectID,
     required: false,
     title: "Default Assign To User ID",
-    description: "Default User ID to assign episodes created by this rule",
+    description:
+      "ID of defaultAssignToUser. Kept for API compatibility: OneUptime does not show it anywhere. To make someone responsible for the episodes this rule opens, use episodeOwnerUsers.",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -1452,7 +1454,8 @@ export default class AlertGroupingRule extends RuleBaseModel {
     type: TableColumnType.Entity,
     modelType: Team,
     title: "Default Assign To Team",
-    description: "Default team to assign episodes created by this rule",
+    description:
+      "Kept for API compatibility: copied to the assignedToTeam of each episode this rule opens while the team belongs to the project. OneUptime does not show it anywhere; to make a team responsible for those episodes, use episodeOwnerTeams.",
   })
   @ManyToOne(
     () => {
@@ -1495,7 +1498,8 @@ export default class AlertGroupingRule extends RuleBaseModel {
     type: TableColumnType.ObjectID,
     required: false,
     title: "Default Assign To Team ID",
-    description: "Default Team ID to assign episodes created by this rule",
+    description:
+      "ID of defaultAssignToTeam. Kept for API compatibility: OneUptime does not show it anywhere. To make a team responsible for the episodes this rule opens, use episodeOwnerTeams.",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -1583,7 +1587,7 @@ export default class AlertGroupingRule extends RuleBaseModel {
     modelType: User,
     title: "Episode Owner Users",
     description:
-      "Users to automatically add as owners to episodes created by this rule.",
+      "Users added as owners of every episode this rule opens, and notified like any owner. Each must be a member of the project.",
   })
   @ManyToMany(
     () => {
@@ -1632,7 +1636,7 @@ export default class AlertGroupingRule extends RuleBaseModel {
     modelType: Team,
     title: "Episode Owner Teams",
     description:
-      "Teams to automatically add as owners to episodes created by this rule.",
+      "Teams added as owners of every episode this rule opens, and notified like any owner. Each must be a team of the project.",
   })
   @ManyToMany(
     () => {

package/Models/DatabaseModels/File.ts

@@ -1,12 +1,17 @@
 import FileModel from "./DatabaseBaseModel/FileModel";
 import Route from "../../Types/API/Route";
+import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
 import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
+import ColumnType from "../../Types/Database/ColumnType";
 import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
 import EnableDocumentation from "../../Types/Database/EnableDocumentation";
+import TableColumn from "../../Types/Database/TableColumn";
+import TableColumnType from "../../Types/Database/TableColumnType";
 import TableMetadata from "../../Types/Database/TableMetadata";
 import IconProp from "../../Types/Icon/IconProp";
+import ObjectID from "../../Types/ObjectID";
 import Permission from "../../Types/Permission";
-import { Entity } from "typeorm";
+import { Column, Entity } from "typeorm";
 
 @EnableDocumentation()
 @TableMetadata({
@@ -26,4 +31,38 @@ import { Entity } from "typeorm";
   delete: [],
   update: [],
 })
-export default class File extends FileModel {}
+export default class File extends FileModel {
+  /*
+   * The project the file was uploaded in: stamped by FileService from the
+   * request's project (the dashboard's tenant, an API key's project) on
+   * every create, whatever the request body says, and never changed or read
+   * through the API. Files have no owner otherwise, so this is what lets a
+   * record that is shown to people outside the project - a form's logo on
+   * its public page - refuse a file uploaded somewhere else (FormService).
+   * Null for files uploaded with no project, and for every file uploaded
+   * before the column existed.
+   *
+   * Nobody may write it, so it is computed, as a password's salt is: the
+   * create's column check, which runs after the stamp, skips it, and a value
+   * a request sends is replaced, never refused.
+   */
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Project ID",
+    description:
+      "The project the file was uploaded in. Set by OneUptime from the request, never from the request body.",
+    computed: true,
+    hideColumnInDocumentation: true,
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public projectId?: ObjectID = undefined;
+}

package/Models/DatabaseModels/Form.ts

@@ -1,3 +1,4 @@
+import File from "./File";
 import Project from "./Project";
 import User from "./User";
 import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
@@ -392,6 +393,131 @@ export default class Form extends BaseModel {
   })
   public ipWhitelist?: string = undefined;
 
+  /*
+   * The form's branding, set in the Build page's Branding section: a logo
+   * shown at the top of its public page in place of the OneUptime logo,
+   * what that logo says for screen readers, and the icon of the browser tab
+   * while the page is open. Files, uploaded as a status page's are, checked
+   * on every write by FormService (Types/Form/FormBranding: an image every
+   * browser draws, 1 MB at most).
+   *
+   * The public page gets them inside the form's own public read, never at
+   * an address of their own and never by a file's id, and the files stay
+   * private. Deleting a file only takes it off the form (SET NULL): a form,
+   * and its submissions, outlive their logo.
+   */
+  @ColumnAccessControl({
+    create: [...CREATE_PERMISSIONS],
+    read: [...READ_PERMISSIONS],
+    update: [...UPDATE_PERMISSIONS],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "logoFileId",
+    type: TableColumnType.Entity,
+    modelType: File,
+    title: "Logo",
+    description:
+      "The image at the top of the form's public page, in place of the OneUptime logo. A PNG, JPEG, GIF, WebP or SVG image of 1 MB or less.",
+  })
+  @ManyToOne(
+    () => {
+      return File;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "logoFileId" })
+  public logoFile?: File = undefined;
+
+  @ColumnAccessControl({
+    create: [...CREATE_PERMISSIONS],
+    read: [...READ_PERMISSIONS],
+    update: [...UPDATE_PERMISSIONS],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Logo File ID",
+    description:
+      "ID of the file the form's public page shows as its logo: upload the image to /api/file first. Leave it empty to show the OneUptime logo.",
+    example: "b8e2c3d4-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public logoFileId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [...CREATE_PERMISSIONS],
+    read: [...READ_PERMISSIONS],
+    update: [...UPDATE_PERMISSIONS],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ShortText,
+    title: "Logo Alt Text",
+    description:
+      "What the logo says, read out by screen readers: usually your organization's name. Leave it empty and screen readers skip the logo.",
+    example: "Acme Inc.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public logoAltText?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [...CREATE_PERMISSIONS],
+    read: [...READ_PERMISSIONS],
+    update: [...UPDATE_PERMISSIONS],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "faviconFileId",
+    type: TableColumnType.Entity,
+    modelType: File,
+    title: "Favicon",
+    description:
+      "The icon in the browser tab while the form's public page is open, in place of the OneUptime favicon. A PNG, JPEG, GIF, WebP or SVG image of 1 MB or less.",
+  })
+  @ManyToOne(
+    () => {
+      return File;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "faviconFileId" })
+  public faviconFile?: File = undefined;
+
+  @ColumnAccessControl({
+    create: [...CREATE_PERMISSIONS],
+    read: [...READ_PERMISSIONS],
+    update: [...UPDATE_PERMISSIONS],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Favicon File ID",
+    description:
+      "ID of the file the form's public page shows as the browser tab's icon: upload the image to /api/file first. Leave it empty to show the OneUptime favicon.",
+    example: "c9f3d4e5-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public faviconFileId?: ObjectID = undefined;
+
   @ColumnAccessControl({
     create: [...CREATE_PERMISSIONS],
     read: [...READ_PERMISSIONS],

package/Models/DatabaseModels/IncidentGroupingRule.ts

@@ -1377,7 +1377,8 @@ export default class IncidentGroupingRule extends RuleBaseModel {
     type: TableColumnType.Entity,
     modelType: User,
     title: "Default Assign To User",
-    description: "Default user to assign episodes created by this rule",
+    description:
+      "Kept for API compatibility: copied to the assignedToUser of each episode this rule opens while the user is a member of the project. OneUptime does not show it anywhere; to make someone responsible for those episodes, use episodeOwnerUsers.",
   })
   @ManyToOne(
     () => {
@@ -1420,7 +1421,8 @@ export default class IncidentGroupingRule extends RuleBaseModel {
     type: TableColumnType.ObjectID,
     required: false,
     title: "Default Assign To User ID",
-    description: "Default User ID to assign episodes created by this rule",
+    description:
+      "ID of defaultAssignToUser. Kept for API compatibility: OneUptime does not show it anywhere. To make someone responsible for the episodes this rule opens, use episodeOwnerUsers.",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -1456,7 +1458,8 @@ export default class IncidentGroupingRule extends RuleBaseModel {
     type: TableColumnType.Entity,
     modelType: Team,
     title: "Default Assign To Team",
-    description: "Default team to assign episodes created by this rule",
+    description:
+      "Kept for API compatibility: copied to the assignedToTeam of each episode this rule opens while the team belongs to the project. OneUptime does not show it anywhere; to make a team responsible for those episodes, use episodeOwnerTeams.",
   })
   @ManyToOne(
     () => {
@@ -1499,7 +1502,8 @@ export default class IncidentGroupingRule extends RuleBaseModel {
     type: TableColumnType.ObjectID,
     required: false,
     title: "Default Assign To Team ID",
-    description: "Default Team ID to assign episodes created by this rule",
+    description:
+      "ID of defaultAssignToTeam. Kept for API compatibility: OneUptime does not show it anywhere. To make a team responsible for the episodes this rule opens, use episodeOwnerTeams.",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -1587,7 +1591,7 @@ export default class IncidentGroupingRule extends RuleBaseModel {
     modelType: User,
     title: "Episode Owner Users",
     description:
-      "Users to automatically add as owners to episodes created by this rule.",
+      "Users added as owners of every episode this rule opens, and notified like any owner. Each must be a member of the project.",
   })
   @ManyToMany(
     () => {
@@ -1636,7 +1640,7 @@ export default class IncidentGroupingRule extends RuleBaseModel {
     modelType: Team,
     title: "Episode Owner Teams",
     description:
-      "Teams to automatically add as owners to episodes created by this rule.",
+      "Teams added as owners of every episode this rule opens, and notified like any owner. Each must be a team of the project.",
   })
   @ManyToMany(
     () => {

package/Models/DatabaseModels/LogDropFilter.ts

@@ -355,6 +355,7 @@ export default class LogDropFilter extends BaseModel {
     title: "Enabled",
     description: "Whether this drop filter is active.",
     defaultValue: true,
+    isDefaultValueColumn: true,
   })
   @Column({
     nullable: false,

package/Models/DatabaseModels/LogPipeline.ts

@@ -280,6 +280,7 @@ export default class LogPipeline extends BaseModel {
     title: "Enabled",
     description: "Whether this log pipeline is active.",
     defaultValue: true,
+    isDefaultValueColumn: true,
   })
   @Column({
     nullable: false,

package/Models/DatabaseModels/LogScrubRule.ts

@@ -18,6 +18,7 @@ import IconProp from "../../Types/Icon/IconProp";
 import ObjectID from "../../Types/ObjectID";
 import Permission from "../../Types/Permission";
 import { PlanType } from "../../Types/Billing/SubscriptionPlan";
+import { LOG_SCRUB_RULE_DEFAULTS } from "../../Types/Telemetry/ScrubRule";
 import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
 
 @EnableDocumentation()
@@ -241,7 +242,7 @@ export default class LogScrubRule extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Pattern Type",
     description:
-      "The type of sensitive data pattern to detect: email, creditCard, ssn, phoneNumber, ipAddress, or custom.",
+      "The type of sensitive data to detect: email, creditCard, ssn, phoneNumber, ipAddress, sensitiveKeys (the whole value of every attribute whose key looks sensitive, such as password or token), or custom (the regular expression in customRegex). Any other value is refused: it would scrub nothing.",
   })
   @Column({
     nullable: false,
@@ -278,7 +279,7 @@ export default class LogScrubRule extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Custom Regex",
     description:
-      "A custom regular expression pattern to match. Only used when patternType is 'custom'.",
+      "The regular expression a 'custom' rule scrubs, written without slashes or flags and matched case-sensitively. Required when patternType is 'custom': a pattern that is empty, does not compile, or matches empty text is refused. Ignored for the other pattern types.",
   })
   @Column({
     nullable: true,
@@ -315,13 +316,15 @@ export default class LogScrubRule extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Scrub Action",
     description:
-      "How to scrub matched data: 'mask' partially hides it, 'hash' replaces with a hash, 'redact' removes entirely.",
+      "How to scrub matched data: 'redact' replaces it with [REDACTED] (the default), 'mask' partially hides it, 'hash' replaces it with a short hash of the value.",
+    defaultValue: LOG_SCRUB_RULE_DEFAULTS.scrubAction,
+    isDefaultValueColumn: true,
   })
   @Column({
     nullable: false,
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
-    default: "redact",
+    default: LOG_SCRUB_RULE_DEFAULTS.scrubAction,
   })
   public scrubAction?: string = undefined;
 
@@ -353,13 +356,15 @@ export default class LogScrubRule extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Fields to Scrub",
     description:
-      "Which log fields to scrub: 'body' (log message only), 'attributes' (attribute values only), or 'both'.",
+      "Which log fields to scrub: 'body' (the log message), 'attributes' (attribute values), or 'both', the default. A sensitiveKeys rule always scrubs attribute values, whatever this says.",
+    defaultValue: LOG_SCRUB_RULE_DEFAULTS.fieldsToScrub,
+    isDefaultValueColumn: true,
   })
   @Column({
     nullable: false,
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
-    default: "both",
+    default: LOG_SCRUB_RULE_DEFAULTS.fieldsToScrub,
   })
   public fieldsToScrub?: string = undefined;
 
@@ -392,12 +397,13 @@ export default class LogScrubRule extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Enabled",
     description: "Whether this scrub rule is active.",
-    defaultValue: true,
+    defaultValue: LOG_SCRUB_RULE_DEFAULTS.isEnabled,
+    isDefaultValueColumn: true,
   })
   @Column({
     nullable: false,
     type: ColumnType.Boolean,
-    default: true,
+    default: LOG_SCRUB_RULE_DEFAULTS.isEnabled,
   })
   public isEnabled?: boolean = undefined;
 

package/Models/DatabaseModels/MetricRecordingRule.ts

@@ -354,7 +354,8 @@ export default class MetricRecordingRule extends BaseModel {
     required: false,
     type: TableColumnType.Number,
     canReadOnRelationQuery: true,
-    description: "Evaluation order when multiple rules exist.",
+    description:
+      "Not read when rules are evaluated: every enabled rule is evaluated each minute, on its own, whatever this holds. The dashboard lists rules by name.",
     defaultValue: 0,
   })
   @Column({

package/Models/DatabaseModels/OnCallDutyPolicyExecutionLogTimeline.ts

@@ -1046,7 +1046,8 @@ export default class OnCallDutyPolicyExecutionLogTimeline extends BaseModel {
     type: TableColumnType.Entity,
     modelType: User,
     title: "Overridden by User",
-    description: "Relation to User who overrode this alert",
+    description:
+      "The user this alert would have paged, when a user override sent it to the Alert Sent To User instead because they were away. Empty when no override applied.",
   })
   @ManyToOne(
     () => {
@@ -1070,7 +1071,8 @@ export default class OnCallDutyPolicyExecutionLogTimeline extends BaseModel {
   @TableColumn({
     type: TableColumnType.ObjectID,
     title: "Overridden by User ID",
-    description: "User ID who overrode this alert",
+    description:
+      "ID of the user this alert would have paged, when a user override sent it to the user in Alert Sent To User ID instead because they were away. Empty when no override applied.",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/OnCallDutyPolicyUserOverride.ts

@@ -77,7 +77,7 @@ import { PlanType } from "../../Types/Billing/SubscriptionPlan";
   pluralName: "User Overrides",
   icon: IconProp.Call,
   tableDescription:
-    "Manage on-call duty user overrides, for example if the user is on leave you can override the on-call duty policy for that user so all the alerts will be routed to the other user.",
+    "While someone is away, a user override sends the alerts that would page them to the person who covers, for a set time. An override on an on-call policy applies to that policy only; one without a policy applies to every on-call policy.",
 })
 export default class OnCallDutyPolicyUserOverride extends BaseModel {
   @ColumnAccessControl({
@@ -191,7 +191,7 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     modelType: OnCallDutyPolicy,
     title: "On-Call Policy",
     description:
-      "Relation to On-Call Policy where this escalation rule belongs.",
+      "The on-call policy this override applies to. Empty for a global override, which applies to every on-call policy.",
   })
   @ManyToOne(
     () => {
@@ -235,7 +235,7 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     canReadOnRelationQuery: true,
     title: "On-Call Policy ID",
     description:
-      "ID of your On-Call Policy where this escalation rule belongs.",
+      "ID of the on-call policy this override applies to. Leave it empty for a global override, which applies to every on-call policy.",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -321,6 +321,13 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
   })
   public createdByUserId?: ObjectID = undefined;
 
+  /*
+   * The person who is AWAY: alerts that would page them go to the
+   * routeAlertsToUser instead while the override is in force. Paging looks
+   * overrides up by this column (OnCallDutyPolicyEscalationRuleService.
+   * getRouteAlertToUserId), and schedules swap this person out
+   * (UserOverrideUtil). The dashboard asks for it as "Who is away?".
+   */
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -348,7 +355,7 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     modelType: User,
     title: "Override User",
     description:
-      "Relation to User who is being overridden by this object (if this object was created by a User)",
+      "The user who is away. While the override is in force, alerts that would page this user go to the Route Alerts To User instead.",
   })
   @ManyToOne(
     () => {
@@ -390,7 +397,7 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     required: true,
     title: "Override User ID",
     description:
-      "User ID who is being overridden by this object (if this object was created by a User)",
+      "ID of the user who is away. While the override is in force, alerts that would page this user go to the user in Route Alerts To User ID instead.",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -399,6 +406,10 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
   })
   public overrideUserId?: ObjectID = undefined;
 
+  /*
+   * The person who COVERS: they get the overrideUser's alerts while the
+   * override is in force. The dashboard asks for it as "Who covers?".
+   */
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,
@@ -426,7 +437,7 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     modelType: User,
     title: "Route Alerts To User",
     description:
-      "Relation to User who is being overridden by this object (if this object was created by a User)",
+      "The user who covers. While the override is in force, this user gets the alerts that would page the Override User.",
   })
   @ManyToOne(
     () => {
@@ -468,7 +479,7 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     required: true,
     title: "Route Alerts To User ID",
     description:
-      "User ID who is being overridden by this object (if this object was created by a User)",
+      "ID of the user who covers. While the override is in force, this user gets the alerts that would page the user in Override User ID.",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -481,7 +492,8 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     title: "Start At",
     type: TableColumnType.Date,
     required: true,
-    description: "When does this start?",
+    description:
+      "When the override starts sending the Override User's alerts to the Route Alerts To User.",
   })
   @ColumnAccessControl({
     create: [
@@ -514,7 +526,8 @@ export default class OnCallDutyPolicyUserOverride extends BaseModel {
     title: "Ends At",
     type: TableColumnType.Date,
     required: true,
-    description: "When does this end?",
+    description:
+      "When the override ends, which has to be after it starts. From then on, alerts page the Override User again.",
   })
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/ProjectCallSMSConfig.ts

@@ -566,7 +566,12 @@ export default class ProjectCallSMSConfig extends BaseModel {
     type: TableColumnType.Boolean,
     title: "Is Project Default",
     description:
-      "When set, all SMS and Calls sent to project team members (on-call notifications, alerts, verification codes, etc.) will use this Twilio config instead of the global config. Only one Twilio config per project can be the project default. This does not affect status pages — they use the config explicitly assigned to each status page.",
+      "When set, all SMS and Calls sent to project team members (on-call notifications, alerts, verification codes, etc.) will use this Twilio config instead of the global config. Only one Twilio config per project can be the project default. A project's first Twilio config becomes the project default when this is not set on create; an explicit false is kept. This does not affect status pages — they use the config explicitly assigned to each status page.",
+    /*
+     * False for every config but a project's first: ProjectCallSMSConfigService
+     * makes the first one the default when the create leaves this out, and
+     * the dashboard's create form starts the switch on for it.
+     */
     defaultValue: false,
   })
   @Column({

package/Models/DatabaseModels/StatusPage.ts

@@ -2685,7 +2685,8 @@ export default class StatusPage extends BaseModel {
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,
     title: "Is Report Enabled",
-    description: "Is Report Enabled for this Status Page?",
+    description:
+      "Whether this status page's email subscribers get reports. Turned on without a schedule, reports go out on the 1st of every month at 09:00 in the report timezone, each covering the calendar month before it.",
     defaultValue: false,
   })
   @Column({
@@ -2730,7 +2731,8 @@ export default class StatusPage extends BaseModel {
   @TableColumn({
     type: TableColumnType.Date,
     title: "Report Start Date Time",
-    description: "When would you like to send the first report?",
+    description:
+      "When the first report goes out. Every later one follows it by the recurring interval, at the same time of day. Left out when reports are turned on, it is 09:00 in the report timezone at the start of the next period of the interval: the next 1st of the month for a monthly schedule (the default), the next Monday for a weekly one, the next day for a daily one and the next 1 January for a yearly one. An hourly schedule starts at the next full hour.",
   })
   @Column({
     type: ColumnType.Date,
@@ -2774,7 +2776,8 @@ export default class StatusPage extends BaseModel {
   @TableColumn({
     type: TableColumnType.JSON,
     title: "Report Recurring Interval",
-    description: "How often would you like to send the report?",
+    description:
+      "How often a report goes out. Left out when reports are turned on, it is every month.",
   })
   @Column({
     type: ColumnType.JSON,
@@ -2819,7 +2822,8 @@ export default class StatusPage extends BaseModel {
   @TableColumn({
     type: TableColumnType.Date,
     title: "Send Next Report By",
-    description: "When should the next report be sent?",
+    description:
+      "When the next report goes out. The server works it out from the schedule.",
   })
   @Index()
   @Column({

package/Models/DatabaseModels/TraceDropFilter.ts

@@ -355,6 +355,7 @@ export default class TraceDropFilter extends BaseModel {
     title: "Enabled",
     description: "Whether this drop filter is active.",
     defaultValue: true,
+    isDefaultValueColumn: true,
   })
   @Column({
     nullable: false,

package/Models/DatabaseModels/TracePipeline.ts

@@ -280,6 +280,7 @@ export default class TracePipeline extends BaseModel {
     title: "Enabled",
     description: "Whether this trace pipeline is active.",
     defaultValue: true,
+    isDefaultValueColumn: true,
   })
   @Column({
     nullable: false,

package/Models/DatabaseModels/TraceRecordingRule.ts

@@ -354,7 +354,8 @@ export default class TraceRecordingRule extends BaseModel {
     required: false,
     type: TableColumnType.Number,
     canReadOnRelationQuery: true,
-    description: "Evaluation order when multiple rules exist.",
+    description:
+      "Not read when rules are evaluated: every enabled rule is evaluated each minute, on its own, whatever this holds. The dashboard lists rules by name.",
     defaultValue: 0,
   })
   @Column({