@oneuptime/common 9.2.15 → 9.2.17

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,

package/Models/DatabaseModels/ScheduledMaintenanceTemplate.ts

@@ -151,6 +151,7 @@ export default class ScheduledMaintenanceTemplate 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,
@@ -185,6 +186,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Name of the Scheduled Maintenance Template",
+    example: "Database Upgrade Template",
   })
   @Column({
     nullable: false,
@@ -219,6 +221,8 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Template Description",
     description: "Description of the Scheduled Maintenance Template",
+    example:
+      "Use this template for scheduled database upgrades and migrations. Includes pre-maintenance notifications, maintenance window updates, and post-maintenance completion notifications.",
   })
   @Column({
     nullable: false,
@@ -254,6 +258,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Title",
     description: "Title of this scheduled event.",
+    example: "Scheduled Database Maintenance - PostgreSQL Upgrade",
   })
   @Column({
     nullable: false,
@@ -288,6 +293,8 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     title: "Description",
     description:
       "Description of this scheduled event that will show up on Status Page. This is a markdown field.",
+    example:
+      "## Scheduled Maintenance\n\nWe will be performing a scheduled upgrade of our PostgreSQL database servers.\n\n**Start Time:** 2:00 AM UTC\n**Expected Duration:** 2 hours\n\n**Impact:** Brief service interruptions may occur during the maintenance window.\n\nThank you for your patience.",
   })
   @Column({
     nullable: true,
@@ -313,6 +320,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "database-upgrade-template",
   })
   @Column({
     nullable: false,
@@ -379,6 +387,7 @@ export default class ScheduledMaintenanceTemplate 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,
@@ -425,6 +434,7 @@ export default class ScheduledMaintenanceTemplate 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,
@@ -635,6 +645,7 @@ export default class ScheduledMaintenanceTemplate 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-4d0e-1f2a-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -650,6 +661,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.Date,
     required: false,
     description: "When would you like to schedule the first event?",
+    example: "2024-03-15T02:00:00.000Z",
   })
   @ColumnAccessControl({
     create: [
@@ -682,6 +694,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.Date,
     required: false,
     description: "When does the first event start?",
+    example: "2024-03-15T02:00:00.000Z",
   })
   @ColumnAccessControl({
     create: [
@@ -714,6 +727,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.Date,
     required: false,
     description: "When does the first event end?",
+    example: "2024-03-15T04:00:00.000Z",
   })
   @ColumnAccessControl({
     create: [
@@ -765,6 +779,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.JSON,
     title: "Recurring Interval",
     description: "How often should this event recur?",
+    example: { intervalType: "weeks", intervalCount: 2 },
   })
   @Column({
     type: ColumnType.JSON,
@@ -798,6 +813,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.Boolean,
     title: "Is Recurring Event",
     description: "Is this a recurring event?",
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -830,6 +846,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.Date,
     title: "Schedule Next Event At",
     description: "When is the next event scheduled?",
+    example: "2024-03-29T02:00:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -865,6 +882,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     title: "Should subscribers be notified when event is created?",
     description: "Should subscribers be notified about this event creation?",
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -900,6 +918,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     description:
       "Should subscribers be notified about this event event is changed to ongoing?",
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -935,6 +954,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     description:
       "Should subscribers be notified about this event event is changed to ended?",
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -969,6 +989,11 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.JSON,
     title: "Custom Fields",
     description: "Custom Fields on this resource.",
+    example: {
+      department: "DevOps",
+      maintenanceType: "upgrade",
+      approvalRequired: true,
+    },
   })
   @Column({
     type: ColumnType.JSON,
@@ -1002,6 +1027,10 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     isDefaultValueColumn: false,
     title: "Subscriber notifications before the event",
     description: "Should subscribers be notified before the event?",
+    example: [
+      { intervalType: "hours", intervalCount: 24 },
+      { intervalType: "hours", intervalCount: 1 },
+    ],
   })
   @Column({
     type: ColumnType.JSON,

package/Models/DatabaseModels/ServiceCatalog.ts

@@ -151,6 +151,7 @@ export default class ServiceCatalog 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,
@@ -186,6 +187,7 @@ export default class ServiceCatalog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "User Authentication API",
   })
   @Column({
     nullable: false,
@@ -247,6 +249,8 @@ export default class ServiceCatalog extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "RESTful API service that handles user authentication, authorization, and session management for the platform",
   })
   @Column({
     nullable: true,
@@ -314,6 +318,7 @@ export default class ServiceCatalog 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,
@@ -372,6 +377,7 @@ export default class ServiceCatalog 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,