@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/OnCallDutyPolicyExecutionLog.ts

@@ -90,6 +90,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -127,6 +128,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -157,6 +159,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "On-Call Policy",
     description:
       "Relation to On-Call Policy which belongs to this execution log event.",
+    example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
   })
   @ManyToOne(
     () => {
@@ -195,6 +198,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "On-Call Policy ID",
     description:
       "ID of your On-Call Policy which belongs to this execution log event.",
+    example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -225,6 +229,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Triggered By Incident",
     description:
       "Relation to Incident which triggered this on-call duty policy.",
+    example: "f6a7b8c9-d0e1-2345-f012-456789012345",
   })
   @ManyToOne(
     () => {
@@ -261,6 +266,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     required: false,
     description:
       "ID of the incident which triggered this on-call escalation policy.",
+    example: "f6a7b8c9-d0e1-2345-f012-456789012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -290,6 +296,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     modelType: Alert,
     title: "Triggered By Alert",
     description: "Relation to Alert which triggered this on-call duty policy.",
+    example: "a7b8c9d0-e1f2-3456-0123-567890123456",
   })
   @ManyToOne(
     () => {
@@ -326,6 +333,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     required: false,
     description:
       "ID of the incident which triggered this on-call escalation policy.",
+    example: "a7b8c9d0-e1f2-3456-0123-567890123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -355,6 +363,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Status",
     description: "Status of this execution",
     canReadOnRelationQuery: false,
+    example: "Executing",
   })
   @Column({
     nullable: false,
@@ -384,6 +393,8 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Status Message",
     description: "Status message of this execution",
     canReadOnRelationQuery: false,
+    example:
+      "On-call policy execution started. Notifying primary on-call team members.",
   })
   @Column({
     nullable: false,
@@ -413,6 +424,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Notification Event Type",
     description: "Type of event that triggered this on-call duty policy.",
     canReadOnRelationQuery: false,
+    example: "IncidentCreated",
   })
   @Column({
     nullable: false,
@@ -443,6 +455,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @ManyToOne(
     () => {
@@ -478,6 +491,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -503,6 +517,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @ManyToOne(
     () => {
@@ -539,6 +554,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -569,6 +585,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Acknowledged by User",
     description:
       "Relation to User who acknowledged this policy execution (if this policy was acknowledged by a User)",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @ManyToOne(
     () => {
@@ -605,6 +622,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who acknowledged this object (if this object was acknowledged by a User)",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -629,7 +647,12 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
 
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Date })
+  @TableColumn({
+    type: TableColumnType.Date,
+    title: "Acknowledged At",
+    description: "When was this policy execution acknowledged?",
+    example: "2024-01-15T10:45:00.000Z",
+  })
   @Column({
     type: ColumnType.Date,
     nullable: true,
@@ -653,6 +676,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Acknowledged by Team",
     description:
       "Relation to Team who acknowledged this policy execution (if this policy was acknowledged by a Team)",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @ManyToOne(
     () => {
@@ -689,6 +713,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Acknowledged by Team ID",
     description:
       "Team ID who acknowledged this object (if this object was acknowledged by a Team)",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -714,6 +739,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Executed Escalation Rule Order",
     description: "Which escalation rule was executed?",
     canReadOnRelationQuery: true,
+    example: 2,
   })
   @Column({
     nullable: true,
@@ -738,6 +764,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Last Escalation Rule Executed At",
     description: "When was the escalation rule executed?",
     canReadOnRelationQuery: true,
+    example: "2024-01-15T10:30:00.000Z",
   })
   @Column({
     nullable: true,
@@ -766,6 +793,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     modelType: OnCallDutyPolicyEscalationRule,
     title: "Last Executed Escalation Rule",
     description: "Relation to On-Call Policy Last Executed Escalation Rule.",
+    example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
   })
   @ManyToOne(
     () => {
@@ -804,6 +832,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Last Executed Escalation Rule ID",
     description: "ID of your On-Call Policy Last Executed Escalation Rule.",
+    example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -830,6 +859,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "Execute next escalation rule in minutes",
     description:
       "How many minutes should we wait before executing the next escalation rule?",
+    example: 15,
   })
   @Column({
     type: ColumnType.Number,
@@ -856,6 +886,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     title: "On-Call Policy Execution Repeat Count",
     description: "How many times did we execute this on-call policy?",
     defaultValue: 1,
+    example: 3,
   })
   @Column({
     type: ColumnType.Number,
@@ -885,6 +916,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     modelType: User,
     title: "Triggered by User",
     description: "Relation to User who triggered on-clal policy",
+    example: "f6a7b8c9-d0e1-2345-f012-456789012345",
   })
   @ManyToOne(
     () => {
@@ -919,6 +951,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
     type: TableColumnType.ObjectID,
     title: "Triggered by User ID",
     description: "User ID who triggered this on-call policy",
+    example: "f6a7b8c9-d0e1-2345-f012-456789012345",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/OnCallDutyPolicyFeed.ts

@@ -97,6 +97,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -134,6 +135,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -163,6 +165,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     modelType: OnCallDutyPolicy,
     title: "OnCallDutyPolicy",
     description: "Relation to OnCallDutyPolicy in which this resource belongs",
+    example: "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
   })
   @ManyToOne(
     () => {
@@ -200,6 +203,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     title: "OnCallDutyPolicy ID",
     description:
       "Relation to OnCallDutyPolicy ID in which this resource belongs",
+    example: "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -230,6 +234,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
   })
   @ManyToOne(
     () => {
@@ -265,6 +270,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -285,6 +291,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
   })
   @ManyToOne(
     () => {
@@ -311,6 +318,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -339,6 +347,8 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     required: true,
     title: "Log (in Markdown)",
     description: "Log of the entire onCallDutyPolicy state change in Markdown",
+    example:
+      "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -367,6 +377,8 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     required: false,
     title: "More Information (in Markdown)",
     description: "More information in Markdown",
+    example:
+      "### Roster Details\n\n- Shift: Weekend (Sat-Sun)\n- Coverage: 24/7\n- Escalation policy applied",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -395,6 +407,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     required: true,
     title: "On Call Duty Policy Feed Event",
     description: "On Call Duty Policy Feed Event",
+    example: "UserAdded",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -424,6 +437,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     required: true,
     title: "Color",
     description: "Display color for the onCallDutyPolicy log",
+    example: "#2ecc71",
   })
   @Column({
     type: ColumnType.Color,
@@ -456,6 +470,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     title: "User",
     description:
       "Relation to User who this feed belongs to (if this feed belongs to a User)",
+    example: "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
   })
   @ManyToOne(
     () => {
@@ -491,6 +506,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     title: "User ID",
     description:
       "User who this feed belongs to (if this feed belongs to a User)",
+    example: "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -518,6 +534,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
     title: "Feed Posted At",
     description: "Date and time when the feed was posted",
     type: TableColumnType.Date,
+    example: "2024-01-15T14:45:30.000Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/OnCallDutyPolicySchedule.ts

@@ -107,6 +107,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -144,6 +145,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -179,6 +181,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "Weekend On-Call Rotation",
   })
   @Column({
     nullable: false,
@@ -214,6 +217,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Labels",
     description:
       "Relation to Labels Array where this object is categorized in.",
+    example: [{ name: "production" }, { name: "critical" }],
   })
   @ManyToMany(
     () => {
@@ -259,6 +263,8 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "This schedule handles on-call duties during weekend hours for production incidents",
   })
   @Column({
     nullable: true,
@@ -290,6 +296,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Slug",
     description: "Friendly globally unique name for your object",
     computed: true,
+    example: "weekend-on-call-rotation",
   })
   @Column({
     nullable: false,
@@ -321,6 +328,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @ManyToOne(
     () => {
@@ -356,6 +364,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -376,6 +385,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @ManyToOne(
     () => {
@@ -402,6 +412,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -431,6 +442,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     modelType: User,
     title: "Current User On Roster",
     description: "Relation to User who is currently on roster",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @ManyToOne(
     () => {
@@ -460,6 +472,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     type: TableColumnType.ObjectID,
     title: "Current User ID On Roster",
     description: "User ID who is currently on roster",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -489,6 +502,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     modelType: User,
     title: "Next User On Roster",
     description: "Relation to User who is next on roster",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @ManyToOne(
     () => {
@@ -518,6 +532,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     type: TableColumnType.ObjectID,
     title: "Next User ID On Roster",
     description: "Next ID who is currently on roster",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -541,6 +556,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Roster Handoff At",
     description:
       "When does the roster handoff occur for this schedule for the current user?",
+    example: "2024-01-15T18:00:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -563,6 +579,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Roster Next Handoff At",
     description:
       "When does the next roster handoff occur for this schedule for the next user?",
+    example: "2024-01-22T18:00:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -585,6 +602,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Roster Next Event Start At",
     description:
       "When does the next event start for this schedule for the next user?",
+    example: "2024-01-22T09:00:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -607,6 +625,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
     title: "Roster Event Start At",
     description:
       "When does the current event start for this schedule for the current user?",
+    example: "2024-01-15T09:00:00.000Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/OnCallDutyPolicyTimeLog.ts

@@ -89,6 +89,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -125,6 +126,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -155,6 +157,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "On-Call Policy ID",
     description:
       "ID of your On-Call Policy where this escalation rule belongs.",
+    example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -185,6 +188,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "On-Call Policy Schedule ID",
     description:
       "ID of your On-Call Policy Schedule where this escalation rule belongs.",
+    example: "f6a7b8c9-d0e1-2345-f012-456789012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -215,6 +219,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "On-Call Policy Escalation Rule ID",
     description:
       "ID of your On-Call Policy Escalation Rule ID where this escalation rule belongs.",
+    example: "a7b8c9d0-e1f2-3456-0123-567890123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -245,6 +250,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "Team ID",
     description:
       "ID of your On-Call Policy Team ID where this escalation rule belongs.",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -273,6 +279,8 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "More Info",
     description: "More information about this log record.",
+    example:
+      "User was on-call during incident INC-1234. Successfully handled 3 alerts during this shift.",
   })
   @Column({
     type: ColumnType.VeryLongText,
@@ -301,6 +309,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @ManyToOne(
     () => {
@@ -335,6 +344,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -364,6 +374,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "Override User",
     description:
       "Relation to User who is being overridden by this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @ManyToOne(
     () => {
@@ -398,6 +409,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     required: true,
     title: "User ID",
     description: "User ID for which this log belongs",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -411,6 +423,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     type: TableColumnType.Date,
     required: true,
     description: "When does this start?",
+    example: "2024-01-15T09:00:00.000Z",
   })
   @ColumnAccessControl({
     create: [
@@ -437,6 +450,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     type: TableColumnType.Date,
     required: false,
     description: "When does this end?",
+    example: "2024-01-15T18:00:00.000Z",
   })
   @ColumnAccessControl({
     create: [
@@ -470,6 +484,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @ManyToOne(
     () => {
@@ -496,6 +511,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/Probe.ts

@@ -138,6 +138,7 @@ export default class Probe extends BaseModel {
     required: true,
     type: TableColumnType.Name,
     canReadOnRelationQuery: true,
+    example: "US East Coast Probe",
   })
   @Column({
     nullable: false,
@@ -161,7 +162,11 @@ export default class Probe extends BaseModel {
       Permission.EditProjectProbe,
     ],
   })
-  @TableColumn({ required: false, type: TableColumnType.Name })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.Name,
+    example: "Monitors services from the US East Coast region",
+  })
   @Column({
     nullable: true,
     type: ColumnType.Name,
@@ -181,6 +186,7 @@ export default class Probe extends BaseModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "us-east-coast-probe",
   })
   @Column({
     nullable: false,
@@ -306,6 +312,7 @@ export default class Probe extends BaseModel {
     title: "Icon",
     description: "Probe Page Icon File ID",
     canReadOnRelationQuery: true,
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -358,6 +365,7 @@ export default class Probe extends BaseModel {
     type: TableColumnType.ObjectID,
     required: false,
     canReadOnRelationQuery: true,
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -397,6 +405,7 @@ export default class Probe extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-def1-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -445,6 +454,7 @@ export default class Probe extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "e5f6a7b8-c9d0-1234-ef12-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,