@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/IncidentOwnerUser.ts

@@ -86,6 +86,7 @@ export default class IncidentOwnerUser 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 IncidentOwnerUser 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 IncidentOwnerUser extends BaseModel {
     title: "User",
     description:
       "User that is the owner. This user will receive notifications. ",
+    example: "e5f6a7b8-c9d0-1234-efab-345678901234",
   })
   @ManyToOne(
     () => {
@@ -190,6 +193,7 @@ export default class IncidentOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of your OneUptime User in which this object belongs",
+    example: "e5f6a7b8-c9d0-1234-efab-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -219,6 +223,7 @@ export default class IncidentOwnerUser extends BaseModel {
     modelType: Incident,
     title: "Incident",
     description: "Relation to Incident Resource in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fabc-456789012345",
   })
   @ManyToOne(
     () => {
@@ -256,6 +261,7 @@ export default class IncidentOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Incident ID",
     description: "ID of your OneUptime Incident in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fabc-456789012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -286,6 +292,7 @@ export default class IncidentOwnerUser extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @ManyToOne(
     () => {
@@ -321,6 +328,7 @@ export default class IncidentOwnerUser extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -346,6 +354,7 @@ export default class IncidentOwnerUser extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @ManyToOne(
     () => {
@@ -377,6 +386,7 @@ export default class IncidentOwnerUser 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-def0-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -408,6 +418,7 @@ export default class IncidentOwnerUser extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/IncidentPublicNote.ts

@@ -134,6 +134,7 @@ export default class IncidentPublicNote 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,
@@ -199,6 +200,7 @@ export default class IncidentPublicNote 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,
@@ -264,6 +266,7 @@ export default class IncidentPublicNote 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,
@@ -310,6 +313,7 @@ export default class IncidentPublicNote 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,
@@ -342,6 +346,8 @@ export default class IncidentPublicNote extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Note",
     description: "Notes in markdown",
+    example:
+      "## Update - Incident Resolved\n\nWe have identified and resolved the issue causing intermittent API failures. Our team has deployed a fix and all services are now operating normally.\n\nWe sincerely apologize for any inconvenience this may have caused. If you continue to experience any issues, please don't hesitate to contact our support team.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -460,6 +466,7 @@ export default class IncidentPublicNote extends BaseModel {
     description:
       "Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons",
     required: false,
+    example: "Successfully notified 1,234 subscribers via email and SMS",
   })
   @Column({
     type: ColumnType.VeryLongText,
@@ -578,6 +585,7 @@ export default class IncidentPublicNote 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/IncidentSeverity.ts

@@ -137,6 +137,7 @@ export default class IncidentSeverity 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,
@@ -171,6 +172,7 @@ export default class IncidentSeverity extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Critical",
   })
   @Column({
     nullable: false,
@@ -230,6 +232,8 @@ export default class IncidentSeverity extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "Critical severity incidents require immediate attention and response from on-call engineers",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/IncidentState.ts

@@ -139,6 +139,7 @@ export default class IncidentState 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,
@@ -173,6 +174,7 @@ export default class IncidentState extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Acknowledged",
   })
   @Column({
     nullable: false,
@@ -232,6 +234,8 @@ export default class IncidentState extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "The incident has been acknowledged by the on-call engineer and is being investigated",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/IncidentStateTimeline.ts

@@ -94,6 +94,7 @@ export default class IncidentStateTimeline extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -131,6 +132,7 @@ export default class IncidentStateTimeline 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,
@@ -160,6 +162,7 @@ export default class IncidentStateTimeline extends BaseModel {
     modelType: Incident,
     title: "Incident",
     description: "Relation to Incident in which this resource belongs",
+    example: "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
   })
   @ManyToOne(
     () => {
@@ -196,6 +199,7 @@ export default class IncidentStateTimeline extends BaseModel {
     required: true,
     title: "Incident ID",
     description: "Relation to Incident ID in which this resource belongs",
+    example: "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -226,6 +230,7 @@ export default class IncidentStateTimeline 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(
     () => {
@@ -261,6 +266,7 @@ export default class IncidentStateTimeline 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,
@@ -281,6 +287,7 @@ export default class IncidentStateTimeline 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(
     () => {
@@ -307,6 +314,7 @@ export default class IncidentStateTimeline 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,
@@ -342,6 +350,7 @@ export default class IncidentStateTimeline extends BaseModel {
     title: "Incident State",
     description:
       "Incident State Relation. Which incident state does this incident change to?",
+    example: "f6a7b8c9-d0e1-2345-6789-0abcdef12345",
   })
   @ManyToOne(
     () => {
@@ -383,6 +392,7 @@ export default class IncidentStateTimeline extends BaseModel {
     title: "Incident State ID",
     description:
       "Incident State ID Relation. Which incident state does this incident change to?",
+    example: "f6a7b8c9-d0e1-2345-6789-0abcdef12345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -420,6 +430,7 @@ export default class IncidentStateTimeline extends BaseModel {
     description:
       "Status of notification sent to subscribers about this incident state change",
     defaultValue: StatusPageSubscriberNotificationStatus.Pending,
+    example: "Sent",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -454,6 +465,8 @@ export default class IncidentStateTimeline extends BaseModel {
     description:
       "Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons",
     required: false,
+    example:
+      "Successfully sent notifications to 47 subscribers via email and SMS",
   })
   @Column({
     type: ColumnType.VeryLongText,
@@ -482,6 +495,7 @@ export default class IncidentStateTimeline extends BaseModel {
     title: "Should subscribers be notified?",
     description: "Should subscribers be notified about this state change?",
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -509,6 +523,7 @@ export default class IncidentStateTimeline extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of state change?",
     defaultValue: false,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -531,6 +546,12 @@ export default class IncidentStateTimeline extends BaseModel {
     isDefaultValueColumn: false,
     required: false,
     type: TableColumnType.JSON,
+    example: {
+      previousState: "investigating",
+      newState: "resolved",
+      triggeredBy: "automated-resolution",
+      duration: 3600,
+    },
   })
   @Column({
     type: ColumnType.JSON,
@@ -560,6 +581,8 @@ export default class IncidentStateTimeline extends BaseModel {
     isDefaultValueColumn: false,
     title: "Root Cause",
     description: "What is the root cause of this status change?",
+    example:
+      "Database connection pool exhaustion caused by sudden spike in traffic from marketing campaign launch.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -587,6 +610,7 @@ export default class IncidentStateTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Ends At",
     description: "When did this status change end?",
+    example: "2024-01-15T14:45:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -615,6 +639,7 @@ export default class IncidentStateTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Starts At",
     description: "When did this status change?",
+    example: "2024-01-15T13:15:00.000Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/IncidentTemplate.ts

@@ -149,6 +149,7 @@ export default class IncidentTemplate 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,
@@ -184,6 +185,7 @@ export default class IncidentTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Title",
     description: "Title of this incident",
+    example: "Production Server Outage - Database Connection Issue",
   })
   @Column({
     nullable: false,
@@ -218,6 +220,7 @@ export default class IncidentTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Name of the Incident Template",
+    example: "Server Outage Template",
   })
   @Column({
     nullable: false,
@@ -252,6 +255,8 @@ export default class IncidentTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Template Description",
     description: "Description of the Incident Template",
+    example:
+      "Use this template when experiencing server outages due to database connectivity issues. Includes automated notifications to on-call engineers and status page updates.",
   })
   @Column({
     nullable: false,
@@ -286,6 +291,8 @@ export default class IncidentTemplate extends BaseModel {
     title: "Description",
     description:
       "Short description of this incident. This is in markdown and will be visible on the status page.",
+    example:
+      "## Issue Description\n\nWe are currently experiencing connectivity issues with our primary database server. Our engineering team is actively investigating and working to resolve the issue.\n\n**Impact:** Users may experience slow response times or intermittent errors.",
   })
   @Column({
     nullable: true,
@@ -311,6 +318,7 @@ export default class IncidentTemplate extends BaseModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "server-outage-template",
   })
   @Column({
     nullable: false,
@@ -377,6 +385,7 @@ export default class IncidentTemplate 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-4a7b-8c9d-0e1f2a3b4c5d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -423,6 +432,7 @@ export default class IncidentTemplate 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-4b8c-9d0e-1f2a3b4c5d6e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -637,6 +647,7 @@ export default class IncidentTemplate extends BaseModel {
     required: false,
     title: "Incident Severity ID",
     description: "Incident Severity ID",
+    example: "c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -708,6 +719,7 @@ export default class IncidentTemplate 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 incident is created.",
+    example: "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -779,6 +791,7 @@ export default class IncidentTemplate extends BaseModel {
     title: "Initial Incident State ID",
     description:
       "Relation to Incident State Object ID. Incidents created from this template will start in this state.",
+    example: "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -813,6 +826,11 @@ export default class IncidentTemplate extends BaseModel {
     type: TableColumnType.JSON,
     title: "Custom Fields",
     description: "Custom Fields on this resource.",
+    example: {
+      priority: "high",
+      category: "infrastructure",
+      escalationLevel: 2,
+    },
   })
   @Column({
     type: ColumnType.JSON,

package/Models/DatabaseModels/IncidentTemplateOwnerTeam.ts

@@ -123,6 +123,7 @@ export default class IncidentTemplateOwnerTeam 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,
@@ -190,6 +191,7 @@ export default class IncidentTemplateOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b0c",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -258,6 +260,7 @@ export default class IncidentTemplateOwnerTeam extends BaseModel {
     title: "IncidentTemplate ID",
     description:
       "ID of your OneUptime IncidentTemplate in which this object belongs",
+    example: "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c1d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -323,6 +326,7 @@ export default class IncidentTemplateOwnerTeam 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-4a7b-8c9d-0e1f2a3b4c5d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -379,6 +383,7 @@ export default class IncidentTemplateOwnerTeam 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-4b8c-9d0e-1f2a3b4c5d6e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -407,6 +412,7 @@ export default class IncidentTemplateOwnerTeam extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/IncidentTemplateOwnerUser.ts

@@ -125,6 +125,7 @@ export default class IncidentTemplateOwnerUser 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,
@@ -194,6 +195,7 @@ export default class IncidentTemplateOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of your OneUptime User in which this object belongs",
+    example: "b8c9d0e1-f2a3-4b4c-5d6e-7f8a9b0c1d2e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -264,6 +266,7 @@ export default class IncidentTemplateOwnerUser extends BaseModel {
     title: "IncidentTemplate ID",
     description:
       "ID of your OneUptime IncidentTemplate in which this object belongs",
+    example: "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c1d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -331,6 +334,7 @@ export default class IncidentTemplateOwnerUser 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-4a7b-8c9d-0e1f2a3b4c5d",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -389,6 +393,7 @@ export default class IncidentTemplateOwnerUser 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-4b8c-9d0e-1f2a3b4c5d6e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -418,6 +423,7 @@ export default class IncidentTemplateOwnerUser extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/Label.ts

@@ -131,6 +131,7 @@ export default class Label extends AccessControlModel {
     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 +164,7 @@ export default class Label extends AccessControlModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Production",
   })
   @Column({
     nullable: false,
@@ -221,6 +223,7 @@ export default class Label extends AccessControlModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "Label for all production environment resources and monitors",
   })
   @Column({
     nullable: true,
@@ -284,6 +287,7 @@ export default class Label extends AccessControlModel {
     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,
@@ -340,6 +344,7 @@ export default class Label extends AccessControlModel {
     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,
@@ -374,6 +379,7 @@ export default class Label extends AccessControlModel {
     type: TableColumnType.Color,
     canReadOnRelationQuery: true,
     description: "Color of this resource in Hex (#32a852 for example)",
+    example: "#32a852",
   })
   @Column({
     type: ColumnType.Color,

package/Models/DatabaseModels/Monitor.ts

@@ -143,6 +143,7 @@ export default class Monitor 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,
@@ -178,6 +179,7 @@ export default class Monitor extends BaseModel {
     title: "Name",
     description: "Any friendly name for this monitor",
     canReadOnRelationQuery: true,
+    example: "Production API Server",
   })
   @Column({
     nullable: false,
@@ -211,6 +213,8 @@ export default class Monitor extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "Monitors the health and availability of our main production API server",
   })
   @Column({
     nullable: true,
@@ -237,6 +241,7 @@ export default class Monitor extends BaseModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "production-api-server",
   })
   @Column({
     nullable: false,
@@ -424,6 +429,7 @@ export default class Monitor extends BaseModel {
     type: TableColumnType.MonitorType,
     title: "Monitor Type",
     description: "What is the type of this monitor? Website? API? etc.",
+    example: "API",
   })
   @Column({
     nullable: false,
@@ -500,6 +506,7 @@ export default class Monitor extends BaseModel {
     title: "Current Monitor Status ID",
     description: "Whats the current status ID of this monitor?",
     canReadOnRelationQuery: true,
+    example: "c3d4e5f6-a7b8-9012-cdef-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -567,6 +574,7 @@ export default class Monitor extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Monitoring Interval",
     description: "How often would you like OneUptime to monitor this resource?",
+    example: "Every 5 minutes",
   })
   @Column({
     nullable: true,
@@ -664,6 +672,7 @@ export default class Monitor extends BaseModel {
     title: "Disable Monitoring",
     description: "Disable active monitoring for this resource?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/MonitorCustomField.ts

@@ -120,6 +120,7 @@ export default class MonitorCustomField 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 MonitorCustomField extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Check Interval",
   })
   @Column({
     nullable: false,
@@ -185,6 +187,8 @@ export default class MonitorCustomField extends BaseModel {
     title: "Description",
     description:
       "Friendly description of this custom field that will help you remember",
+    example:
+      "This field specifies how often the monitor should perform health checks (in minutes)",
   })
   @Column({
     nullable: true,
@@ -212,6 +216,7 @@ export default class MonitorCustomField extends BaseModel {
     type: TableColumnType.CustomFieldType,
     title: "Custom Field Type",
     description: "Is this field Text, Number or Boolean?",
+    example: "Number",
   })
   @Column({
     nullable: true,
@@ -275,6 +280,7 @@ export default class MonitorCustomField 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 MonitorCustomField 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,