@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/ScheduledMaintenanceFeed.ts

@@ -99,6 +99,7 @@ export default class ScheduledMaintenanceFeed 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 ScheduledMaintenanceFeed 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,
@@ -166,6 +168,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     title: "ScheduledMaintenance",
     description:
       "Relation to ScheduledMaintenance in which this resource belongs",
+    example: "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f",
   })
   @ManyToOne(
     () => {
@@ -203,6 +206,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     title: "ScheduledMaintenance ID",
     description:
       "Relation to ScheduledMaintenance ID in which this resource belongs",
+    example: "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -233,6 +237,7 @@ export default class ScheduledMaintenanceFeed 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(
     () => {
@@ -268,6 +273,7 @@ export default class ScheduledMaintenanceFeed 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,
@@ -288,6 +294,7 @@ export default class ScheduledMaintenanceFeed 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(
     () => {
@@ -314,6 +321,7 @@ export default class ScheduledMaintenanceFeed 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,
@@ -343,6 +351,8 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     title: "Log (in Markdown)",
     description:
       "Log of the entire scheduled maintenance state change in Markdown",
+    example:
+      "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -371,6 +381,8 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     required: false,
     title: "More Information (in Markdown)",
     description: "More information in Markdown",
+    example:
+      "### Additional Details\n\n- All services will be temporarily unavailable\n- Email notifications sent to all subscribers\n- Backup completed successfully",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -399,6 +411,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     required: true,
     title: "ScheduledMaintenance Log Event",
     description: "ScheduledMaintenance Log Event",
+    example: "ScheduledMaintenanceCreated",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -429,6 +442,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     required: true,
     title: "Color",
     description: "Display color for this log",
+    example: "#3498db",
   })
   @Column({
     type: ColumnType.Color,
@@ -461,6 +475,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     title: "User",
     description:
       "Relation to User who this feed belongs to (if this feed belongs to a User)",
+    example: "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
   })
   @ManyToOne(
     () => {
@@ -496,6 +511,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
     title: "User ID",
     description:
       "User who this feed belongs to (if this feed belongs to a User)",
+    example: "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -523,6 +539,7 @@ export default class ScheduledMaintenanceFeed 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/ScheduledMaintenanceInternalNote.ts

@@ -132,6 +132,7 @@ export default class ScheduledMaintenanceInternalNote 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 ScheduledMaintenanceInternalNote extends BaseModel {
     required: true,
     title: "Scheduled Maintenance ID",
     description: "ID of Scheduled Maintenance this resource belongs to",
+    example: "c3d4e5f6-a7b8-9012-cdef-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -263,6 +265,7 @@ export default class ScheduledMaintenanceInternalNote 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 ScheduledMaintenanceInternalNote 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 ScheduledMaintenanceInternalNote extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Note",
     description: "Notes in markdown",
+    example:
+      "## Scheduled Maintenance Completed\n\nSuccessfully completed the database upgrade from PostgreSQL 14 to 15. All services were migrated smoothly with zero data loss.\n\n**Summary:**\n- Downtime: 45 minutes (scheduled for 60 minutes)\n- Database upgrade completed\n- All automated tests passed\n- Services restored and monitored for 30 minutes post-maintenance",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -447,6 +453,7 @@ export default class ScheduledMaintenanceInternalNote 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,

package/Models/DatabaseModels/ScheduledMaintenanceNoteTemplate.ts

@@ -86,6 +86,7 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -123,6 +124,7 @@ export default class ScheduledMaintenanceNoteTemplate 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,8 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
     title: "Note",
     description:
       "Note template for public or private notes. This is in markdown.",
+    example:
+      "## Scheduled Maintenance Update\n\n**Maintenance Window**: {{maintenance.scheduledAt}} - {{maintenance.endTime}}\n\n**Affected Services**: {{maintenance.services}}\n\n**Status**: The scheduled maintenance has been completed successfully. All systems are now operational.\n\n**Summary of Work Performed**:\n- Database schema upgrades applied\n- Security patches installed\n- Performance optimizations implemented\n\n**Verification**: All post-maintenance tests have passed. Services are running normally.\n\n**Next Scheduled Maintenance**: TBD",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -191,6 +195,7 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Name of the Incident Template",
+    example: "Maintenance Completion Summary",
   })
   @Column({
     nullable: false,
@@ -225,6 +230,8 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Template Description",
     description: "Description of the Incident Template",
+    example:
+      "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
   })
   @Column({
     nullable: false,
@@ -255,6 +262,7 @@ export default class ScheduledMaintenanceNoteTemplate 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(
     () => {
@@ -290,6 +298,7 @@ export default class ScheduledMaintenanceNoteTemplate 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,
@@ -310,6 +319,7 @@ export default class ScheduledMaintenanceNoteTemplate 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(
     () => {
@@ -336,6 +346,7 @@ export default class ScheduledMaintenanceNoteTemplate 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/ScheduledMaintenanceOwnerTeam.ts

@@ -87,6 +87,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "project-id-5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -124,6 +125,7 @@ export default class ScheduledMaintenanceOwnerTeam 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,
@@ -154,6 +156,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     title: "Team",
     description:
       "Team that is the owner. All users in this team will receive notifications. ",
+    example: "team-id-7a9d1e2f-b3c4-5d6e-9f0a-1b2c3d4e5f6a",
   })
   @ManyToOne(
     () => {
@@ -191,6 +194,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "7a9d1e2f-b3c4-5d6e-9f0a-1b2c3d4e5f6a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -221,6 +225,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     title: "ScheduledMaintenance",
     description:
       "Relation to ScheduledMaintenance Resource in which this object belongs",
+    example: "scheduled-maintenance-id-4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
   })
   @ManyToOne(
     () => {
@@ -259,6 +264,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     title: "ScheduledMaintenance ID",
     description:
       "ID of your OneUptime ScheduledMaintenance in which this object belongs",
+    example: "4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -289,6 +295,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "user-id-9b1c3d5e-f7a9-4c2e-8d6f-0a1b2c3d4e5f",
   })
   @ManyToOne(
     () => {
@@ -324,6 +331,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "9b1c3d5e-f7a9-4c2e-8d6f-0a1b2c3d4e5f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -349,6 +357,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "user-id-2d4f6a8c-e1b3-5d7e-9f0a-1c2d3e4f5a6b",
   })
   @ManyToOne(
     () => {
@@ -380,6 +389,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "2d4f6a8c-e1b3-5d7e-9f0a-1c2d3e4f5a6b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -408,6 +418,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/ScheduledMaintenanceOwnerUser.ts

@@ -86,6 +86,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "project-id-5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -123,6 +124,7 @@ export default class ScheduledMaintenanceOwnerUser 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,
@@ -153,6 +155,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     title: "User",
     description:
       "User that is the owner. This user will receive notifications. ",
+    example: "user-id-8c1d3e5f-a7b9-4c2e-9d6f-1a2b3c4d5e6f",
   })
   @ManyToOne(
     () => {
@@ -190,6 +193,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of your OneUptime User in which this object belongs",
+    example: "8c1d3e5f-a7b9-4c2e-9d6f-1a2b3c4d5e6f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -220,6 +224,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     title: "ScheduledMaintenance",
     description:
       "Relation to ScheduledMaintenance Resource in which this object belongs",
+    example: "scheduled-maintenance-id-4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
   })
   @ManyToOne(
     () => {
@@ -258,6 +263,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     title: "ScheduledMaintenance ID",
     description:
       "ID of your OneUptime ScheduledMaintenance in which this object belongs",
+    example: "4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -288,6 +294,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "user-id-9b1c3d5e-f7a9-4c2e-8d6f-0a1b2c3d4e5f",
   })
   @ManyToOne(
     () => {
@@ -323,6 +330,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "9b1c3d5e-f7a9-4c2e-8d6f-0a1b2c3d4e5f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -348,6 +356,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "user-id-2d4f6a8c-e1b3-5d7e-9f0a-1c2d3e4f5a6b",
   })
   @ManyToOne(
     () => {
@@ -379,6 +388,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "2d4f6a8c-e1b3-5d7e-9f0a-1c2d3e4f5a6b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -407,6 +417,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/ScheduledMaintenancePublicNote.ts

@@ -134,6 +134,7 @@ export default class ScheduledMaintenancePublicNote 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,
@@ -200,6 +201,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     required: true,
     title: "Scheduled Maintenance ID",
     description: "ID of Scheduled Maintenance this resource belongs to",
+    example: "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -265,6 +267,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -311,6 +314,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "c3d4e5f6-a7b8-9012-c3d4-e5f6a7b89012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -343,6 +347,8 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Note",
     description: "Notes in markdown",
+    example:
+      "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -427,6 +433,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     title: "Subscriber Notification Status",
     description: "Status of notification sent to subscribers about this note",
     defaultValue: StatusPageSubscriberNotificationStatus.Pending,
+    example: "Sent",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -461,6 +468,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     description:
       "Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons",
     required: false,
+    example: "Successfully sent notification to 150 subscribers",
   })
   @Column({
     type: ColumnType.VeryLongText,
@@ -489,6 +497,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     title: "Should subscribers be notified?",
     description: "Should subscribers be notified about this note?",
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -517,6 +526,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -549,6 +559,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
     title: "Note Posted At",
     description: "Date and time when the note was posted",
     type: TableColumnType.Date,
+    example: "2024-01-15T14:30:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -579,6 +590,7 @@ export default class ScheduledMaintenancePublicNote 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,

package/Models/DatabaseModels/ScheduledMaintenanceStateTimeline.ts

@@ -90,6 +90,7 @@ export default class ScheduledMaintenanceStateTimeline 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 ScheduledMaintenanceStateTimeline 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 ScheduledMaintenanceStateTimeline extends BaseModel {
     title: "Scheduled Maintenance",
     description:
       "Relation to Scheduled Maintenance Event this resource belongs to",
+    example: "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
   })
   @ManyToOne(
     () => {
@@ -193,6 +196,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     required: true,
     title: "Scheduled Maintenance ID",
     description: "ID of Scheduled Maintenance this resource belongs to",
+    example: "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -223,6 +227,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @ManyToOne(
     () => {
@@ -258,6 +263,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -278,6 +284,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @ManyToOne(
     () => {
@@ -304,6 +311,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -339,6 +347,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     title: "Scheduled Maintenance State",
     description:
       "Which state does this event belongs to?. Relation to Scheduled Maintenance State",
+    example: "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
   })
   @ManyToOne(
     () => {
@@ -380,6 +389,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     title: "Scheduled Maintenance State ID",
     description:
       " Scheduled Maintenance State ID. Which state does this event belongs to?",
+    example: "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -417,6 +427,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     description:
       "Status of notification sent to subscribers about this scheduled maintenance state change",
     defaultValue: StatusPageSubscriberNotificationStatus.Pending,
+    example: "Sent",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -451,6 +462,8 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     description:
       "Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons",
     required: false,
+    example:
+      "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC",
   })
   @Column({
     type: ColumnType.VeryLongText,
@@ -478,6 +491,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     type: TableColumnType.Boolean,
     title: "Should subscribers be notified?",
     description: "Should subscribers be notified about this state change?",
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -504,6 +518,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     isDefaultValueColumn: true,
     title: "Are Owners Notified",
     description: "Are owners notified of state change?",
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -532,6 +547,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Ends At",
     description: "When did this status change end?",
+    example: "2024-01-16T04:00:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -560,6 +576,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Starts At",
     description: "When did this status change?",
+    example: "2024-01-16T02:00:00.000Z",
   })
   @Column({
     type: ColumnType.Date,