@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/PromoCode.ts

@@ -48,6 +48,7 @@ export default class PromoCode extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Resller ID",
     description: "ID that is shared between resller and OneUptime.",
+    example: "SUMMER2024",
   })
   @Column({
     nullable: false,
@@ -68,6 +69,7 @@ export default class PromoCode extends BaseModel {
     title: "Plan Type",
     description:
       "If this promocode can be used for specific plan, please specify here. If null, it can be used for all the plans",
+    example: "Growth",
   })
   @Column({
     nullable: true,
@@ -88,6 +90,7 @@ export default class PromoCode extends BaseModel {
     title: "User Email",
     description:
       "Which user can redeem this promocode? If no one is specified, anyone can redeem this promocode.",
+    example: "user@example.com",
   })
   @Column({
     nullable: true,
@@ -118,6 +121,7 @@ export default class PromoCode 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(
     () => {
@@ -152,6 +156,7 @@ export default class PromoCode 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,
@@ -177,6 +182,7 @@ export default class PromoCode 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(
     () => {
@@ -208,6 +214,7 @@ export default class PromoCode 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,
@@ -227,6 +234,7 @@ export default class PromoCode extends BaseModel {
     modelType: Reseller,
     title: "Reseller",
     description: "Relation to Reseller Resource in which this object belongs",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @ManyToOne(
     () => {
@@ -254,6 +262,7 @@ export default class PromoCode extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Reseller ID",
     description: "ID of your OneUptime Reseller in which this object belongs",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -274,6 +283,7 @@ export default class PromoCode extends BaseModel {
     title: "ResellerPlan",
     description:
       "Relation to ResellerPlan Resource in which this object belongs",
+    example: "d4e5f6a7-b8c9-0123-def1-234567890123",
   })
   @ManyToOne(
     () => {
@@ -302,6 +312,7 @@ export default class PromoCode extends BaseModel {
     title: "Reseller Plan ID",
     description:
       "ID of your OneUptime Reseller Plan in which this object belongs",
+    example: "d4e5f6a7-b8c9-0123-def1-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -332,6 +343,7 @@ export default class PromoCode extends BaseModel {
     title: "License ID",
     description: "License ID from a OneUptime Reseller",
     canReadOnRelationQuery: true,
+    example: "LIC-2024-ABCD1234",
   })
   @Column({
     nullable: true,
@@ -349,6 +361,7 @@ export default class PromoCode extends BaseModel {
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -361,7 +374,11 @@ export default class PromoCode extends BaseModel {
     read: [],
     update: [],
   })
-  @TableColumn({ isDefaultValueColumn: false, type: TableColumnType.Date })
+  @TableColumn({
+    isDefaultValueColumn: false,
+    type: TableColumnType.Date,
+    example: "2024-06-15T10:30:00.000Z",
+  })
   @Column({
     type: ColumnType.Date,
     nullable: true,
@@ -380,6 +397,7 @@ export default class PromoCode extends BaseModel {
     title: "Project",
     description:
       "If promo code is used for a specific project, please specify here.",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -408,6 +426,7 @@ export default class PromoCode extends BaseModel {
     title: "Project ID",
     description:
       "If promo code is used for a specific project, please specify here.",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/PushNotificationLog.ts

@@ -75,6 +75,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -107,6 +108,7 @@ export default class PushNotificationLog 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,
@@ -131,6 +133,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "Title",
     description: "Title of the push notification",
     canReadOnRelationQuery: false,
+    example: "Alert: High CPU Usage Detected",
   })
   @Column({
     nullable: false,
@@ -155,6 +158,8 @@ export default class PushNotificationLog extends BaseModel {
     title: "Body",
     description: "Body of the push notification",
     canReadOnRelationQuery: false,
+    example:
+      "Your server 'web-server-01' has exceeded 90% CPU usage for the past 5 minutes.",
   })
   @Column({
     nullable: true,
@@ -178,6 +183,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "Device Type",
     description: "Type of device this was sent to (e.g., web)",
     canReadOnRelationQuery: false,
+    example: "web",
   })
   @Column({
     nullable: true,
@@ -202,6 +208,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "Device Name",
     description: "Name of the device this was sent to",
     canReadOnRelationQuery: false,
+    example: "Chrome on MacOS",
   })
   @Column({
     nullable: true,
@@ -226,6 +233,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "Status Message",
     description: "Status Message (if any)",
     canReadOnRelationQuery: false,
+    example: "Notification sent successfully",
   })
   @Column({
     nullable: true,
@@ -250,6 +258,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "Status",
     description: "Status of the push notification",
     canReadOnRelationQuery: false,
+    example: "Sent",
   })
   @Column({
     nullable: false,
@@ -276,6 +285,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: Incident,
     title: "Incident",
     description: "Incident associated with this Push (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @ManyToOne(
     () => {
@@ -308,6 +318,7 @@ export default class PushNotificationLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Incident ID",
     description: "ID of Incident associated with this Push (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -332,6 +343,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: User,
     title: "User",
     description: "User who initiated this Push notification (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @ManyToOne(
     () => {
@@ -364,6 +376,7 @@ export default class PushNotificationLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of User who initiated this Push notification (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -388,6 +401,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: Alert,
     title: "Alert",
     description: "Alert associated with this Push (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @ManyToOne(
     () => {
@@ -420,6 +434,7 @@ export default class PushNotificationLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Alert ID",
     description: "ID of Alert associated with this Push (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -444,6 +459,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: ScheduledMaintenance,
     title: "Scheduled Maintenance",
     description: "Scheduled Maintenance associated with this Push (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @ManyToOne(
     () => {
@@ -477,6 +493,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "Scheduled Maintenance ID",
     description:
       "ID of Scheduled Maintenance associated with this Push (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -501,6 +518,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: StatusPage,
     title: "Status Page",
     description: "Status Page associated with this Push (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @ManyToOne(
     () => {
@@ -533,6 +551,7 @@ export default class PushNotificationLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Status Page ID",
     description: "ID of Status Page associated with this Push (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -557,6 +576,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: StatusPageAnnouncement,
     title: "Status Page Announcement",
     description: "Status Page Announcement associated with this Push (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @ManyToOne(
     () => {
@@ -590,6 +610,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "Status Page Announcement ID",
     description:
       "ID of Status Page Announcement associated with this Push (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -615,6 +636,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "On-Call Duty Policy",
     description:
       "On-Call Duty Policy associated with this Push Notification (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @ManyToOne(
     () => {
@@ -648,6 +670,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "On-Call Duty Policy ID",
     description:
       "ID of On-Call Duty Policy associated with this Push Notification (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -673,6 +696,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule",
     description:
       "On-Call Duty Policy Escalation Rule associated with this Push Notification (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @ManyToOne(
     () => {
@@ -707,6 +731,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule ID",
     description:
       "ID of On-Call Duty Policy Escalation Rule associated with this Push Notification (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -732,6 +757,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "On-Call Duty Policy Schedule",
     description:
       "On-Call Duty Policy Schedule associated with this Push Notification (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @ManyToOne(
     () => {
@@ -765,6 +791,7 @@ export default class PushNotificationLog extends BaseModel {
     title: "On-Call Duty Policy Schedule ID",
     description:
       "ID of On-Call Duty Policy Schedule associated with this Push Notification (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -789,6 +816,7 @@ export default class PushNotificationLog extends BaseModel {
     modelType: Team,
     title: "Team",
     description: "Team associated with this Push Notification (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @ManyToOne(
     () => {
@@ -821,6 +849,7 @@ export default class PushNotificationLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of Team associated with this Push Notification (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -841,6 +870,7 @@ export default class PushNotificationLog 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(
     () => {
@@ -867,6 +897,7 @@ export default class PushNotificationLog 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/Reseller.ts

@@ -44,6 +44,7 @@ export default class Reseller extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Resller ID",
     description: "ID that is shared between resller and OneUptime.",
+    example: "reseller_1234567890",
   })
   @Column({
     nullable: false,
@@ -63,6 +64,7 @@ export default class Reseller extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Name of the reseller",
+    example: "Enterprise Solutions Inc.",
   })
   @Column({
     nullable: false,
@@ -82,6 +84,7 @@ export default class Reseller extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Description",
     description: "Description of the reseller",
+    example: "Leading provider of monitoring solutions for enterprises",
   })
   @Column({
     nullable: false,
@@ -101,6 +104,7 @@ export default class Reseller extends BaseModel {
     canReadOnRelationQuery: false,
     title: "Username",
     description: "Username of the reseller",
+    example: "enterprise_admin",
   })
   @Column({
     nullable: false,
@@ -120,6 +124,7 @@ export default class Reseller extends BaseModel {
     canReadOnRelationQuery: false,
     title: "Password",
     description: "Password for reseller to login",
+    example: "$2b$10$abcdefghijklmnopqrstuvwxyz1234567890",
   })
   @Column({
     nullable: false,
@@ -140,6 +145,7 @@ export default class Reseller 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(
     () => {
@@ -165,6 +171,7 @@ export default class Reseller 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,
@@ -185,6 +192,7 @@ export default class Reseller 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(
     () => {
@@ -211,6 +219,7 @@ export default class Reseller 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,
@@ -230,6 +239,7 @@ export default class Reseller extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Change Plan Link",
     description: "Reseller Change plan Link",
+    example: "https://reseller.oneuptime.com/change-plan",
   })
   @Column({
     nullable: true,
@@ -251,6 +261,7 @@ export default class Reseller extends BaseModel {
     title: "Hide Phone Number on Signup",
     description:
       "Should we hide the phone number on sign up form based on reseller request?",
+    example: true,
   })
   @Column({
     nullable: true,
@@ -270,6 +281,7 @@ export default class Reseller extends BaseModel {
     title: "Enable Telemetry Features",
     description: "Should we enable telemetry features for this reseller?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/ResellerPlan.ts

@@ -46,6 +46,7 @@ export default class ResellerPlan extends BaseModel {
     modelType: Reseller,
     title: "Reseller",
     description: "Relation to Reseller Resource in which this object belongs",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @ManyToOne(
     () => {
@@ -73,6 +74,7 @@ export default class ResellerPlan extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Reseller ID",
     description: "ID of your OneUptime Reseller in which this object belongs",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -93,6 +95,7 @@ export default class ResellerPlan extends BaseModel {
     title: "Plan ID",
     description:
       "ID of the plan. This is shared by the Reseller and OneUptime.",
+    example: "plan_enterprise_2024",
   })
   @Column({
     nullable: false,
@@ -112,6 +115,7 @@ export default class ResellerPlan extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Name of the Reseller Plan",
+    example: "Enterprise Plan",
   })
   @Column({
     nullable: false,
@@ -131,6 +135,7 @@ export default class ResellerPlan extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Plan Type",
     description: "Name of the Base Plan that the project should created with.",
+    example: "Growth",
   })
   @Column({
     nullable: false,
@@ -150,6 +155,7 @@ export default class ResellerPlan extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Description",
     description: "Description of the Reseller Plan",
+    example: "Comprehensive monitoring solution for large organizations",
   })
   @Column({
     nullable: false,
@@ -169,6 +175,7 @@ export default class ResellerPlan extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Monitor Limit",
     description: "Monitor Limit of the OneUptime Project.",
+    example: 100,
   })
   @Column({
     nullable: true,
@@ -187,6 +194,7 @@ export default class ResellerPlan extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team Member Limit",
     description: "Team Member Limit of the OneUptime Project.",
+    example: 25,
   })
   @Column({
     nullable: true,
@@ -206,6 +214,7 @@ export default class ResellerPlan 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(
     () => {
@@ -231,6 +240,7 @@ export default class ResellerPlan 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,
@@ -251,6 +261,7 @@ export default class ResellerPlan 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(
     () => {
@@ -277,6 +288,7 @@ export default class ResellerPlan 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,
@@ -297,6 +309,7 @@ export default class ResellerPlan extends BaseModel {
     title: "Other Features",
     description:
       "Other Features of this Reseller Plan. This is shown on the dashboard. Its a comma separated list of features",
+    example: "Advanced Analytics, Custom Integrations, Priority Support",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/ScheduledMaintenance.ts

@@ -145,6 +145,7 @@ export default class ScheduledMaintenance 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,
@@ -180,6 +181,7 @@ export default class ScheduledMaintenance extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Title",
     description: "Title of this scheduled event.",
+    example: "Database Migration and Server Upgrade",
   })
   @Column({
     nullable: false,
@@ -214,6 +216,8 @@ export default class ScheduledMaintenance extends BaseModel {
     title: "Description",
     description:
       "Description of this scheduled event that will show up on Status Page. This is in markdown.",
+    example:
+      "We will be performing routine database maintenance and upgrading our servers to improve performance. Services may experience brief interruptions during this window.",
   })
   @Column({
     nullable: true,
@@ -309,6 +313,7 @@ export default class ScheduledMaintenance 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,
@@ -355,6 +360,7 @@ export default class ScheduledMaintenance 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-f2345678901a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -572,6 +578,7 @@ export default class ScheduledMaintenance extends BaseModel {
     title: "Current Scheduled Maintenance State ID",
     description:
       "Scheduled Maintenance State ID. The state the event currently is in.",
+    example: "c3d4e5f6-a7b8-9012-cdef-3456789012ab",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -643,6 +650,7 @@ export default class ScheduledMaintenance extends BaseModel {
     title: "Change Monitor Status To ID",
     description:
       "Relation to Monitor Status Object ID. All monitors connected to this incident will be changed to this status when the event is ongoing.",
+    example: "d4e5f6a7-b8c9-0123-def4-56789012abcd",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/ScheduledMaintenanceCustomField.ts

@@ -120,6 +120,7 @@ export default class ScheduledMaintenanceCustomField 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 ScheduledMaintenanceCustomField extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Maintenance Window",
   })
   @Column({
     nullable: false,
@@ -185,6 +187,8 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
     title: "Description",
     description:
       "Friendly description of this custom field that will help you remember",
+    example:
+      "This field indicates the maintenance window type (Planned, Emergency, Routine)",
   })
   @Column({
     nullable: true,
@@ -212,6 +216,7 @@ export default class ScheduledMaintenanceCustomField 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 ScheduledMaintenanceCustomField 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 ScheduledMaintenanceCustomField 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,