@oneuptime/common 9.2.15 → 9.2.17

package/Models/DatabaseModels/Dashboard.ts

@@ -97,6 +97,7 @@ export default class Dashboard extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -133,6 +134,7 @@ export default class Dashboard 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,
@@ -165,6 +167,7 @@ export default class Dashboard extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Production Monitoring Dashboard",
   })
   @Column({
     nullable: false,
@@ -191,6 +194,7 @@ export default class Dashboard extends BaseModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "production-monitoring-dashboard",
   })
   @Column({
     nullable: false,
@@ -222,6 +226,7 @@ export default class Dashboard extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "Dashboard for monitoring production infrastructure and services",
   })
   @Column({
     nullable: true,
@@ -251,6 +256,7 @@ export default class Dashboard extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -285,6 +291,7 @@ export default class Dashboard extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -310,6 +317,7 @@ export default class Dashboard extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -341,6 +349,7 @@ export default class Dashboard extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -376,6 +385,7 @@ export default class Dashboard extends BaseModel {
     title: "Labels",
     description:
       "Relation to Labels Array where this object is categorized in.",
+    example: [{ id: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e" }],
   })
   @ManyToMany(
     () => {
@@ -419,6 +429,7 @@ export default class Dashboard extends BaseModel {
     type: TableColumnType.JSON,
     title: "Dashboard View Config",
     description: "Configuration of Dashboard View",
+    example: { components: [], layout: "grid" },
   })
   @Column({
     nullable: false,

package/Models/DatabaseModels/Domain.ts

@@ -114,6 +114,7 @@ export default class Domain 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,
@@ -146,6 +147,7 @@ export default class Domain extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Domain",
     description: "Domain - acmeinc.com for example.",
+    example: "status.acmeinc.com",
   })
   @Column({
     nullable: false,
@@ -236,6 +238,7 @@ export default class Domain 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,
@@ -292,6 +295,7 @@ export default class Domain 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,
@@ -351,6 +355,7 @@ export default class Domain extends BaseModel {
     title: "Domain Verification Text",
     description:
       "Verification text that you need to add to your domains TXT record to veify the domain.",
+    example: "oneuptime-verify=a1b2c3d4e5f67890abcdef1234567890",
   })
   @Column({
     type: ColumnType.ShortText,

package/Models/DatabaseModels/EmailLog.ts

@@ -77,6 +77,7 @@ export default class EmailLog extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -109,6 +110,7 @@ export default class EmailLog 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,
@@ -134,6 +136,7 @@ export default class EmailLog extends BaseModel {
     title: "To Email",
     description: "Email address where the mail was sent",
     canReadOnRelationQuery: false,
+    example: "user@example.com",
   })
   @Column({
     nullable: true,
@@ -160,6 +163,7 @@ export default class EmailLog extends BaseModel {
     title: "From Email",
     description: "Email address where the mail was sent from",
     canReadOnRelationQuery: false,
+    example: "notification@example.com",
   })
   @Column({
     nullable: true,
@@ -185,6 +189,7 @@ export default class EmailLog extends BaseModel {
     title: "Email Subject",
     description: "Subject of the email sent",
     canReadOnRelationQuery: false,
+    example: "Alert: High CPU Usage Detected on Server",
   })
   @Column({
     nullable: false,
@@ -209,6 +214,7 @@ export default class EmailLog extends BaseModel {
     title: "Status Message",
     description: "Status Message (if any)",
     canReadOnRelationQuery: false,
+    example: "Email delivered successfully",
   })
   @Column({
     nullable: true,
@@ -233,6 +239,7 @@ export default class EmailLog extends BaseModel {
     title: "Status of the SMS",
     description: "Status of the SMS sent",
     canReadOnRelationQuery: false,
+    example: "Sent",
   })
   @Column({
     nullable: false,
@@ -258,6 +265,7 @@ export default class EmailLog extends BaseModel {
     title: "Project Smtp Config Id",
     description:
       "Relation to ProjectSmtpConfig resource in which this object belongs",
+    example: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
   })
   @ManyToOne(
     () => {
@@ -290,6 +298,7 @@ export default class EmailLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project Smtp Config ID",
     description: "ID of your Project Smtp Config in which this object belongs",
+    example: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -316,6 +325,7 @@ export default class EmailLog extends BaseModel {
     modelType: Incident,
     title: "Incident",
     description: "Incident associated with this email (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @ManyToOne(
     () => {
@@ -348,6 +358,7 @@ export default class EmailLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Incident ID",
     description: "ID of Incident associated with this email (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -372,6 +383,7 @@ export default class EmailLog extends BaseModel {
     modelType: User,
     title: "User",
     description: "User who initiated this email (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @ManyToOne(
     () => {
@@ -404,6 +416,7 @@ export default class EmailLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of User who initiated this email (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -428,6 +441,7 @@ export default class EmailLog extends BaseModel {
     modelType: Alert,
     title: "Alert",
     description: "Alert associated with this email (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @ManyToOne(
     () => {
@@ -460,6 +474,7 @@ export default class EmailLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Alert ID",
     description: "ID of Alert associated with this email (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -484,6 +499,7 @@ export default class EmailLog extends BaseModel {
     modelType: ScheduledMaintenance,
     title: "Scheduled Maintenance",
     description: "Scheduled Maintenance associated with this email (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @ManyToOne(
     () => {
@@ -517,6 +533,7 @@ export default class EmailLog extends BaseModel {
     title: "Scheduled Maintenance ID",
     description:
       "ID of Scheduled Maintenance associated with this email (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -541,6 +558,7 @@ export default class EmailLog extends BaseModel {
     modelType: StatusPage,
     title: "Status Page",
     description: "Status Page associated with this email (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @ManyToOne(
     () => {
@@ -573,6 +591,7 @@ export default class EmailLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Status Page ID",
     description: "ID of Status Page associated with this email (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -597,6 +616,7 @@ export default class EmailLog extends BaseModel {
     modelType: StatusPageAnnouncement,
     title: "Status Page Announcement",
     description: "Status Page Announcement associated with this email (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @ManyToOne(
     () => {
@@ -630,6 +650,7 @@ export default class EmailLog extends BaseModel {
     title: "Status Page Announcement ID",
     description:
       "ID of Status Page Announcement associated with this email (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -654,6 +675,7 @@ export default class EmailLog extends BaseModel {
     modelType: OnCallDutyPolicy,
     title: "On-Call Duty Policy",
     description: "On-Call Duty Policy associated with this email (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @ManyToOne(
     () => {
@@ -687,6 +709,7 @@ export default class EmailLog extends BaseModel {
     title: "On-Call Duty Policy ID",
     description:
       "ID of On-Call Duty Policy associated with this email (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -712,6 +735,7 @@ export default class EmailLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule",
     description:
       "On-Call Duty Policy Escalation Rule associated with this email (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @ManyToOne(
     () => {
@@ -746,6 +770,7 @@ export default class EmailLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule ID",
     description:
       "ID of On-Call Duty Policy Escalation Rule associated with this email (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -771,6 +796,7 @@ export default class EmailLog extends BaseModel {
     title: "On-Call Duty Policy Schedule",
     description:
       "On-Call Duty Policy Schedule associated with this email (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @ManyToOne(
     () => {
@@ -804,6 +830,7 @@ export default class EmailLog extends BaseModel {
     title: "On-Call Duty Policy Schedule ID",
     description:
       "ID of On-Call Duty Policy Schedule associated with this email (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -828,6 +855,7 @@ export default class EmailLog extends BaseModel {
     modelType: Team,
     title: "Team",
     description: "Team associated with this email (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @ManyToOne(
     () => {
@@ -860,6 +888,7 @@ export default class EmailLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of Team associated with this email (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -880,6 +909,7 @@ export default class EmailLog extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "f2a3b4c5-0123-abf5-cdef-cdef01234567",
   })
   @ManyToOne(
     () => {
@@ -906,6 +936,7 @@ export default class EmailLog extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "f2a3b4c5-0123-abf5-cdef-cdef01234567",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/Incident.ts

@@ -153,6 +153,7 @@ export default class Incident 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,
@@ -188,6 +189,7 @@ export default class Incident extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Title",
     description: "Title of this incident",
+    example: "Database connection failure in production",
   })
   @Column({
     nullable: false,
@@ -222,6 +224,8 @@ export default class Incident extends BaseModel {
     title: "Description",
     description:
       "Short description of this incident. This is in markdown and will be visible on the status page.",
+    example:
+      "Our engineering team is investigating database connectivity issues affecting the main production cluster.",
   })
   @Column({
     nullable: true,
@@ -256,6 +260,7 @@ export default class Incident extends BaseModel {
     title: "Declared At",
     description: "Date and time when this incident was declared.",
     isDefaultValueColumn: true,
+    example: "2024-01-15T09:30:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -284,6 +289,7 @@ export default class Incident extends BaseModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "database-connection-failure-in-production",
   })
   @Column({
     nullable: false,
@@ -612,6 +618,7 @@ export default class Incident extends BaseModel {
     required: true,
     title: "Current Incident State ID",
     description: "Current Incident State ID",
+    example: "d4e5f6a7-b8c9-0123-defg-456789012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -687,6 +694,7 @@ export default class Incident extends BaseModel {
     required: true,
     title: "Incident Severity ID",
     description: "Incident Severity ID",
+    example: "e5f6a7b8-c9d0-1234-efgh-567890123456",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/IncidentCustomField.ts

@@ -120,6 +120,7 @@ export default class IncidentCustomField 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,
@@ -152,6 +153,7 @@ export default class IncidentCustomField extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Severity Level",
   })
   @Column({
     nullable: false,
@@ -185,6 +187,8 @@ export default class IncidentCustomField extends BaseModel {
     title: "Description",
     description:
       "Friendly description of this custom field that will help you remember",
+    example:
+      "This field tracks the severity level of the incident (Minor, Major, Critical)",
   })
   @Column({
     nullable: true,
@@ -212,6 +216,7 @@ export default class IncidentCustomField extends BaseModel {
     type: TableColumnType.CustomFieldType,
     title: "Custom Field Type",
     description: "Is this field Text, Number or Boolean?",
+    example: "Text",
   })
   @Column({
     nullable: true,
@@ -275,6 +280,7 @@ export default class IncidentCustomField extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -331,6 +337,7 @@ export default class IncidentCustomField extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "b5c4d3e2-f1a0-4b5c-9d8e-7f6a5b4c3d2e",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/IncidentFeed.ts

@@ -99,6 +99,7 @@ export default class IncidentFeed extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -136,6 +137,7 @@ export default class IncidentFeed 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,
@@ -165,6 +167,7 @@ export default class IncidentFeed extends BaseModel {
     modelType: Incident,
     title: "Incident",
     description: "Relation to Incident in which this resource belongs",
+    example: "a1b2c3d4-f5e6-7890-1234-567890abcdef",
   })
   @ManyToOne(
     () => {
@@ -201,6 +204,7 @@ export default class IncidentFeed extends BaseModel {
     required: true,
     title: "Incident ID",
     description: "Relation to Incident ID in which this resource belongs",
+    example: "a1b2c3d4-f5e6-7890-1234-567890abcdef",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -231,6 +235,7 @@ export default class IncidentFeed extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "b2c3d4e5-a6b7-8901-2345-678901bcdef0",
   })
   @ManyToOne(
     () => {
@@ -266,6 +271,7 @@ export default class IncidentFeed extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "b2c3d4e5-a6b7-8901-2345-678901bcdef0",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -286,6 +292,7 @@ export default class IncidentFeed extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "c3d4e5f6-b7c8-9012-3456-789012cdef01",
   })
   @ManyToOne(
     () => {
@@ -312,6 +319,7 @@ export default class IncidentFeed extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "c3d4e5f6-b7c8-9012-3456-789012cdef01",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -340,6 +348,8 @@ export default class IncidentFeed extends BaseModel {
     required: true,
     title: "Log (in Markdown)",
     description: "Log of the entire incident state change in Markdown",
+    example:
+      "**Incident State Changed**: Status changed from `Acknowledged` to `Resolved` by John Doe",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -368,6 +378,8 @@ export default class IncidentFeed extends BaseModel {
     required: false,
     title: "More Information (in Markdown)",
     description: "More information in Markdown",
+    example:
+      "### Resolution Details\n\nThe issue was resolved by restarting the database service. All systems are now operational.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -396,6 +408,7 @@ export default class IncidentFeed extends BaseModel {
     required: true,
     title: "Incident Feed Event",
     description: "Incident Feed Event",
+    example: "IncidentStateChanged",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -424,6 +437,7 @@ export default class IncidentFeed extends BaseModel {
     required: true,
     title: "Color",
     description: "Display color for the incident log",
+    example: "#e74c3c",
   })
   @Column({
     type: ColumnType.Color,
@@ -456,6 +470,7 @@ export default class IncidentFeed extends BaseModel {
     title: "User",
     description:
       "Relation to User who this feed belongs to (if this feed belongs to a User)",
+    example: "d4e5f6a7-c8d9-0123-4567-890123def012",
   })
   @ManyToOne(
     () => {
@@ -491,6 +506,7 @@ export default class IncidentFeed extends BaseModel {
     title: "User ID",
     description:
       "User who this feed belongs to (if this feed belongs to a User)",
+    example: "d4e5f6a7-c8d9-0123-4567-890123def012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -518,6 +534,7 @@ export default class IncidentFeed extends BaseModel {
     title: "Feed Posted At",
     description: "Date and time when the feed was posted",
     type: TableColumnType.Date,
+    example: "2024-01-15T10:30:00.000Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/IncidentInternalNote.ts

@@ -133,6 +133,7 @@ export default class IncidentInternalNote 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,
@@ -198,6 +199,7 @@ export default class IncidentInternalNote extends BaseModel {
     required: true,
     title: "Incident ID",
     description: "Relation to Incident ID in which this resource belongs",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -263,6 +265,7 @@ export default class IncidentInternalNote extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -309,6 +312,7 @@ export default class IncidentInternalNote extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "9d0e1f2a-b3c4-5d6e-af7b-8c9d0e1f2a3b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -341,6 +345,8 @@ export default class IncidentInternalNote extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Note",
     description: "Notes in markdown",
+    example:
+      "## Root Cause Analysis\n\nInvestigated the database connection timeout. Found that the connection pool was exhausted due to a memory leak in the authentication service.\n\n**Action Items:**\n- Applied hotfix to authentication service\n- Increased connection pool size from 10 to 20\n- Added monitoring alerts for connection pool usage",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -447,6 +453,7 @@ export default class IncidentInternalNote extends BaseModel {
     description:
       "Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message.",
     required: false,
+    example: "C1234567890:1234567890.123456",
   })
   @Column({
     type: ColumnType.LongText,