@oneuptime/common 9.2.15 → 9.2.17

package/Models/DatabaseModels/Alert.ts

@@ -149,6 +149,7 @@ export default class Alert 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 Alert extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Title",
     description: "Title of this alert",
+    example: "High CPU usage detected on production server",
   })
   @Column({
     nullable: false,
@@ -218,6 +220,8 @@ export default class Alert extends BaseModel {
     title: "Description",
     description:
       "Short description of this alert. This will be visible on the status page. This is in markdown.",
+    example:
+      "CPU usage has exceeded 90% threshold for the past 5 minutes. Immediate investigation required.",
   })
   @Column({
     nullable: true,
@@ -574,6 +578,7 @@ export default class Alert extends BaseModel {
     isDefaultValueColumn: true,
     title: "Current Alert State ID",
     description: "Current Alert State ID",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -650,6 +655,7 @@ export default class Alert extends BaseModel {
     required: true,
     title: "Alert Severity ID",
     description: "Alert Severity ID",
+    example: "b2c3d4e5-f6a7-8901-bcde-f23456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -809,6 +815,8 @@ export default class Alert extends BaseModel {
     isDefaultValueColumn: false,
     title: "Root Cause",
     description: "What is the root cause of this alert?",
+    example:
+      "Memory leak in the application caused by improper resource cleanup in the connection pool.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -970,6 +978,8 @@ export default class Alert extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Remediation Notes",
     description: "Notes on how to remediate this alert. This is in markdown.",
+    example:
+      "1. Restart the affected service\\n2. Clear the connection pool\\n3. Monitor memory usage for the next 30 minutes",
   })
   @Column({
     nullable: true,
@@ -1033,6 +1043,7 @@ export default class Alert extends BaseModel {
     computed: true,
     title: "Alert Number",
     description: "Alert Number",
+    example: 42,
   })
   @Column({
     type: ColumnType.Number,

package/Models/DatabaseModels/AlertCustomField.ts

@@ -120,6 +120,7 @@ export default class AlertCustomField 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 AlertCustomField extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Priority Level",
   })
   @Column({
     nullable: false,
@@ -185,6 +187,8 @@ export default class AlertCustomField extends BaseModel {
     title: "Description",
     description:
       "Friendly description of this custom field that will help you remember",
+    example:
+      "This field indicates the priority level of the alert (Low, Medium, High, Critical)",
   })
   @Column({
     nullable: true,
@@ -212,6 +216,7 @@ export default class AlertCustomField 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 AlertCustomField 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 AlertCustomField 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,

package/Models/DatabaseModels/AlertFeed.ts

@@ -136,6 +136,7 @@ export default class AlertFeed 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,
@@ -201,6 +202,7 @@ export default class AlertFeed extends BaseModel {
     required: true,
     title: "Alert ID",
     description: "Relation to Alert ID in which this resource belongs",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -266,6 +268,7 @@ export default class AlertFeed 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-345678901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -340,6 +343,8 @@ export default class AlertFeed extends BaseModel {
     required: true,
     title: "Log (in Markdown)",
     description: "Log of the entire alert state change in Markdown",
+    example:
+      "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -396,6 +401,7 @@ export default class AlertFeed extends BaseModel {
     required: true,
     title: "Alert Feed Event",
     description: "Alert Feed Event",
+    example: "AlertStateChanged",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -425,6 +431,7 @@ export default class AlertFeed extends BaseModel {
     required: true,
     title: "Color",
     description: "Display color for the alert log",
+    example: "#e74c3c",
   })
   @Column({
     type: ColumnType.Color,
@@ -492,6 +499,7 @@ export default class AlertFeed extends BaseModel {
     title: "User ID",
     description:
       "User who this feed belongs to (if this feed belongs to a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f23456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -519,6 +527,7 @@ export default class AlertFeed extends BaseModel {
     title: "Feed Posted At",
     description: "Date and time when the feed was posted",
     type: TableColumnType.Date,
+    example: "2024-01-15T10:30:00.000Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/AlertInternalNote.ts

@@ -133,6 +133,7 @@ export default class AlertInternalNote extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -198,6 +199,7 @@ export default class AlertInternalNote extends BaseModel {
     required: true,
     title: "Alert ID",
     description: "Relation to Alert ID in which this resource belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f23456789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -263,6 +265,7 @@ export default class AlertInternalNote extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -309,6 +312,7 @@ export default class AlertInternalNote extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "9d0e1f2a-b3c4-5d6e-af7b-8c9d0e1f2a3b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -341,6 +345,8 @@ export default class AlertInternalNote extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Note",
     description: "Notes in markdown",
+    example:
+      "## Alert Investigation\n\nChecked the server logs and found high CPU usage on web-server-03. The process `node-worker-12` was consuming 95% CPU.\n\n**Resolution:**\n- Restarted the worker process\n- Alert cleared automatically after 2 minutes\n- Will monitor for recurrence and investigate if this happens again",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -447,6 +453,7 @@ export default class AlertInternalNote 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/AlertNoteTemplate.ts

@@ -93,6 +93,7 @@ export default class AlertNoteTemplate extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -130,6 +131,7 @@ export default class AlertNoteTemplate 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,
@@ -164,6 +166,8 @@ export default class AlertNoteTemplate extends BaseModel {
     title: "Note",
     description:
       "Note template for public or private notes. This is in markdown.",
+    example:
+      "## Alert Investigation\n\n**Issue**: {{alert.title}}\n\n**Time**: {{alert.createdAt}}\n\n**Analysis**: Initial investigation shows that the alert was triggered due to high CPU usage on the production server. The team is currently investigating the root cause.\n\n**Next Steps**:\n- Monitor system metrics\n- Review application logs\n- Check for memory leaks",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -198,6 +202,7 @@ export default class AlertNoteTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Name of the Alert Template",
+    example: "Initial Investigation Template",
   })
   @Column({
     nullable: false,
@@ -232,6 +237,8 @@ export default class AlertNoteTemplate extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Template Description",
     description: "Description of the Alert Template",
+    example:
+      "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
   })
   @Column({
     nullable: false,
@@ -262,6 +269,7 @@ export default class AlertNoteTemplate 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(
     () => {
@@ -297,6 +305,7 @@ export default class AlertNoteTemplate 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,
@@ -317,6 +326,7 @@ export default class AlertNoteTemplate 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(
     () => {
@@ -343,6 +353,7 @@ export default class AlertNoteTemplate 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/AlertOwnerTeam.ts

@@ -87,6 +87,7 @@ export default class AlertOwnerTeam extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -124,6 +125,7 @@ export default class AlertOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -154,6 +156,7 @@ export default class AlertOwnerTeam extends BaseModel {
     title: "Team",
     description:
       "Team that is the owner. All users in this team will receive notifications. ",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @ManyToOne(
     () => {
@@ -191,6 +194,7 @@ export default class AlertOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -220,6 +224,7 @@ export default class AlertOwnerTeam extends BaseModel {
     modelType: Alert,
     title: "Alert",
     description: "Relation to Alert Resource in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @ManyToOne(
     () => {
@@ -257,6 +262,7 @@ export default class AlertOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Alert ID",
     description: "ID of your OneUptime Alert in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -287,6 +293,7 @@ export default class AlertOwnerTeam 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(
     () => {
@@ -322,6 +329,7 @@ export default class AlertOwnerTeam 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,
@@ -347,6 +355,7 @@ export default class AlertOwnerTeam 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(
     () => {
@@ -378,6 +387,7 @@ export default class AlertOwnerTeam 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,
@@ -409,6 +419,7 @@ export default class AlertOwnerTeam 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/AlertOwnerUser.ts

@@ -86,6 +86,7 @@ export default class AlertOwnerUser 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 AlertOwnerUser 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 AlertOwnerUser 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 AlertOwnerUser 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 AlertOwnerUser extends BaseModel {
     modelType: Alert,
     title: "Alert",
     description: "Relation to Alert Resource in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @ManyToOne(
     () => {
@@ -256,6 +261,7 @@ export default class AlertOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Alert ID",
     description: "ID of your OneUptime Alert in which this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -286,6 +292,7 @@ export default class AlertOwnerUser 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 AlertOwnerUser 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 AlertOwnerUser 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 AlertOwnerUser 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 AlertOwnerUser 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/AlertSeverity.ts

@@ -137,6 +137,7 @@ export default class AlertSeverity 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 AlertSeverity extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "High",
   })
   @Column({
     nullable: false,
@@ -230,6 +232,8 @@ export default class AlertSeverity extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "High severity alerts indicate significant issues that need prompt attention within 1 hour",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/AlertState.ts

@@ -140,6 +140,7 @@ export default class AlertState 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,
@@ -174,6 +175,7 @@ export default class AlertState extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Acknowledged",
   })
   @Column({
     nullable: false,
@@ -208,6 +210,8 @@ export default class AlertState extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "The alert has been acknowledged by a team member and is being investigated",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/AlertStateTimeline.ts

@@ -91,6 +91,7 @@ export default class AlertStateTimeline 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 AlertStateTimeline 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 AlertStateTimeline extends BaseModel {
     modelType: Alert,
     title: "Alert",
     description: "Relation to Alert in which this resource belongs",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @ManyToOne(
     () => {
@@ -193,6 +196,7 @@ export default class AlertStateTimeline extends BaseModel {
     required: true,
     title: "Alert ID",
     description: "Relation to Alert ID in which this resource belongs",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -223,6 +227,7 @@ export default class AlertStateTimeline 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 AlertStateTimeline 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 AlertStateTimeline 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 AlertStateTimeline 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 AlertStateTimeline extends BaseModel {
     title: "Alert State",
     description:
       "Alert State Relation. Which alert state does this alert change to?",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @ManyToOne(
     () => {
@@ -380,6 +389,7 @@ export default class AlertStateTimeline extends BaseModel {
     title: "Alert State ID",
     description:
       "Alert State ID Relation. Which alert state does this alert change to?",
+    example: "d4e5f6a7-b8c9-0123-def0-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -408,6 +418,7 @@ export default class AlertStateTimeline extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of state change?",
     defaultValue: false,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -430,6 +441,11 @@ export default class AlertStateTimeline extends BaseModel {
     isDefaultValueColumn: false,
     required: false,
     type: TableColumnType.JSON,
+    example: {
+      previousState: "created",
+      newState: "acknowledged",
+      reason: "Alert reviewed by on-call engineer",
+    },
   })
   @Column({
     type: ColumnType.JSON,
@@ -460,6 +476,8 @@ export default class AlertStateTimeline extends BaseModel {
     isDefaultValueColumn: false,
     title: "Root Cause",
     description: "What is the root cause of this status change?",
+    example:
+      "High memory usage detected on production server due to memory leak in application code.",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -487,6 +505,7 @@ export default class AlertStateTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Ends At",
     description: "When did this status change end?",
+    example: "2024-01-15T12:30:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -515,6 +534,7 @@ export default class AlertStateTimeline extends BaseModel {
     type: TableColumnType.Date,
     title: "Starts At",
     description: "When did this status change?",
+    example: "2024-01-15T10:30:00.000Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/ApiKey.ts

@@ -118,6 +118,7 @@ export default class ApiKey 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,
@@ -150,6 +151,7 @@ export default class ApiKey extends BaseModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "Production API Key",
   })
   @Column({
     nullable: false,
@@ -180,6 +182,8 @@ export default class ApiKey extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "API key used for production environment monitoring and alerting integrations",
   })
   @Column({
     nullable: true,
@@ -265,6 +269,7 @@ export default class ApiKey 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,
@@ -311,6 +316,7 @@ export default class ApiKey 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,
@@ -341,6 +347,7 @@ export default class ApiKey extends BaseModel {
     type: TableColumnType.Date,
     required: true,
     description: "Date and Time when this API Key expires.",
+    example: "2025-12-31T23:59:59Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -368,6 +375,7 @@ export default class ApiKey extends BaseModel {
     title: "API Key",
     computed: true,
     description: "Secret API Key",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,