@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/MonitorSecret.ts

@@ -100,6 +100,7 @@ export default class MonitorSecret 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 MonitorSecret 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,
@@ -170,6 +172,7 @@ export default class MonitorSecret extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "API_AUTH_TOKEN",
   })
   @Column({
     nullable: false,
@@ -204,6 +207,7 @@ export default class MonitorSecret extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "API authentication token for third-party service integration",
   })
   @Column({
     nullable: true,
@@ -232,6 +236,7 @@ export default class MonitorSecret extends BaseModel {
     title: "Secret Value",
     description:
       "Secret value that you want to store in this object. This value will be encrypted and only accessible by the probe.",
+    example: "sk_test_1234567890abcdefghijklmnop",
   })
   @Column({
     nullable: true,
@@ -262,6 +267,7 @@ export default class MonitorSecret extends BaseModel {
     modelType: Monitor,
     title: "Monitors",
     description: "List of monitors that can access this secret",
+    example: '["5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"]',
   })
   @ManyToMany(
     () => {
@@ -303,6 +309,7 @@ export default class MonitorSecret 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(
     () => {
@@ -337,6 +344,7 @@ export default class MonitorSecret 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,
@@ -362,6 +370,7 @@ export default class MonitorSecret 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(
     () => {
@@ -393,6 +402,7 @@ export default class MonitorSecret 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,

package/Models/DatabaseModels/MonitorStatus.ts

@@ -138,6 +138,7 @@ export default class MonitorStatus 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,
@@ -172,6 +173,7 @@ export default class MonitorStatus extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Operational",
   })
   @Column({
     nullable: false,
@@ -231,6 +233,7 @@ export default class MonitorStatus extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "The monitor is running normally and all systems are operational",
   })
   @Column({
     nullable: true,
@@ -296,6 +299,7 @@ export default class MonitorStatus 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,
@@ -352,6 +356,7 @@ export default class MonitorStatus 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/MonitorStatusTimeline.ts

@@ -95,6 +95,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -132,6 +133,7 @@ export default class MonitorStatusTimeline 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,
@@ -161,6 +163,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor Resource in which this object belongs",
+    example: "a7b8c9d0-e1f2-3456-789a-bcdef0123456",
   })
   @ManyToOne(
     () => {
@@ -197,6 +200,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     required: true,
     title: "Monitor ID",
     description: "Relation to Monitor ID Resource in which this object belongs",
+    example: "a7b8c9d0-e1f2-3456-789a-bcdef0123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -227,6 +231,7 @@ export default class MonitorStatusTimeline 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(
     () => {
@@ -262,6 +267,7 @@ export default class MonitorStatusTimeline 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,
@@ -282,6 +288,7 @@ export default class MonitorStatusTimeline 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(
     () => {
@@ -308,6 +315,7 @@ export default class MonitorStatusTimeline 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,
@@ -343,6 +351,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     title: "Monitor Status",
     description:
       "Relation to Monitor Status Resource in which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-890a-bcdef0123456",
   })
   @ManyToOne(
     () => {
@@ -384,6 +393,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     title: "Monitor Status ID",
     description:
       "Relation to Monitor Status ID Resource in which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-890a-bcdef0123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -412,6 +422,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of status change?",
     defaultValue: false,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -434,6 +445,12 @@ export default class MonitorStatusTimeline extends BaseModel {
     isDefaultValueColumn: false,
     required: false,
     type: TableColumnType.JSON,
+    example: {
+      previousStatus: "operational",
+      newStatus: "degraded",
+      responseTime: 2500,
+      probeLocation: "us-east-1",
+    },
   })
   @Column({
     type: ColumnType.JSON,
@@ -463,6 +480,8 @@ export default class MonitorStatusTimeline extends BaseModel {
     isDefaultValueColumn: false,
     title: "Root Cause",
     description: "What is the root cause of this status change?",
+    example:
+      "API response time exceeded threshold of 2000ms due to database query optimization needed on user table.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -490,6 +509,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Ends At",
     description: "When did this status change end?",
+    example: "2024-01-15T16:20:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -518,6 +538,7 @@ export default class MonitorStatusTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Starts At",
     description: "When did this status change?",
+    example: "2024-01-15T15:45:00.000Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/MonitorTest.ts

@@ -91,6 +91,7 @@ export default class MonitorTest extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -128,6 +129,7 @@ export default class MonitorTest 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,
@@ -158,6 +160,7 @@ export default class MonitorTest 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(
     () => {
@@ -193,6 +196,7 @@ export default class MonitorTest 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,
@@ -213,6 +217,7 @@ export default class MonitorTest 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(
     () => {
@@ -239,6 +244,7 @@ export default class MonitorTest 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,
@@ -267,6 +273,7 @@ export default class MonitorTest extends BaseModel {
     type: TableColumnType.MonitorType,
     title: "Monitor Type",
     description: "What is the type of this monitor? Website? API? etc.",
+    example: "website",
   })
   @Column({
     nullable: false,
@@ -300,6 +307,7 @@ export default class MonitorTest extends BaseModel {
     required: false,
     title: "Monitor Steps",
     description: "What would you like to monitor and what is the criteria?",
+    example: '{"steps": [{"url": "https://example.com", "method": "GET"}]}',
   })
   @Column({
     type: ColumnType.JSON,
@@ -334,6 +342,7 @@ export default class MonitorTest extends BaseModel {
     modelType: Probe,
     title: "Probe",
     description: "Relation to Probe Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -376,6 +385,7 @@ export default class MonitorTest extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Probe ID",
     description: "ID of your OneUptime Probe in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -404,7 +414,10 @@ export default class MonitorTest extends BaseModel {
       Permission.EditProjectMonitor,
     ],
   })
-  @TableColumn({ type: TableColumnType.Date })
+  @TableColumn({
+    type: TableColumnType.Date,
+    example: "2023-01-15T10:30:00Z",
+  })
   @Column({
     type: ColumnType.Date,
     nullable: true,
@@ -436,6 +449,7 @@ export default class MonitorTest extends BaseModel {
     isDefaultValueColumn: false,
     required: false,
     type: TableColumnType.JSON,
+    example: '{"responseTime": 250, "statusCode": 200}',
   })
   @Column({
     type: ColumnType.JSON,
@@ -470,6 +484,7 @@ export default class MonitorTest extends BaseModel {
     required: true,
     type: TableColumnType.Boolean,
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -501,6 +516,7 @@ export default class MonitorTest extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Monitor ID",
     description: "ID of the Monitor this test is related to.",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -530,6 +546,7 @@ export default class MonitorTest extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor Resource in which this test belongs.",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {

package/Models/DatabaseModels/OnCallDutyPolicy.ts

@@ -138,6 +138,7 @@ export default class OnCallDutyPolicy 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 OnCallDutyPolicy extends BaseModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "24/7 Production Support",
   })
   @Column({
     nullable: false,
@@ -253,6 +255,8 @@ export default class OnCallDutyPolicy extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "Primary on-call rotation for production incidents and critical alerts",
   })
   @Column({
     nullable: true,
@@ -350,6 +354,7 @@ export default class OnCallDutyPolicy 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,
@@ -396,6 +401,7 @@ export default class OnCallDutyPolicy 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,

package/Models/DatabaseModels/OnCallDutyPolicyEscalationRule.ts

@@ -80,6 +80,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -117,6 +118,7 @@ export default class OnCallDutyPolicyEscalationRule 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,
@@ -147,6 +149,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
     title: "On-Call Policy",
     description:
       "Relation to On-Call Policy where this escalation rule belongs.",
+    example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
   })
   @ManyToOne(
     () => {
@@ -185,6 +188,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
     title: "On-Call Policy ID",
     description:
       "ID of your On-Call Policy where this escalation rule belongs.",
+    example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -220,6 +224,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "Escalate to Team Lead",
   })
   @Column({
     nullable: false,
@@ -253,6 +258,8 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "If no response after 15 minutes, escalate to the team lead for immediate attention",
   })
   @Column({
     nullable: true,
@@ -283,6 +290,7 @@ export default class OnCallDutyPolicyEscalationRule 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(
     () => {
@@ -318,6 +326,7 @@ export default class OnCallDutyPolicyEscalationRule 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,
@@ -338,6 +347,7 @@ export default class OnCallDutyPolicyEscalationRule 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(
     () => {
@@ -364,6 +374,7 @@ export default class OnCallDutyPolicyEscalationRule 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,
@@ -400,6 +411,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
     description:
       "How long should we wait before we execute the next escalation rule?",
     canReadOnRelationQuery: true,
+    example: 15,
   })
   @Column({
     nullable: true,
@@ -432,6 +444,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
     type: TableColumnType.Number,
     title: "Order",
     description: "Order of this rule",
+    example: 1,
   })
   @Column({
     type: ColumnType.Number,