@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/SmsLog.ts

@@ -76,6 +76,7 @@ export default class SmsLog extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -108,6 +109,7 @@ export default class SmsLog 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,
@@ -133,6 +135,7 @@ export default class SmsLog extends BaseModel {
     title: "To Number",
     description: "Phone Number SMS was sent to",
     canReadOnRelationQuery: false,
+    example: "+1-555-123-4567",
   })
   @Column({
     nullable: false,
@@ -159,6 +162,7 @@ export default class SmsLog extends BaseModel {
     title: "From Number",
     description: "Phone Number SMS was sent from",
     canReadOnRelationQuery: false,
+    example: "+1-555-999-8888",
   })
   @Column({
     nullable: true,
@@ -184,6 +188,8 @@ export default class SmsLog extends BaseModel {
     title: "SMS Text",
     description: "Text content of the message",
     canReadOnRelationQuery: false,
+    example:
+      "Alert: High CPU usage detected on your server. Please investigate immediately.",
   })
   @Column({
     nullable: true,
@@ -207,6 +213,7 @@ export default class SmsLog extends BaseModel {
     title: "Status Message",
     description: "Status Message (if any)",
     canReadOnRelationQuery: false,
+    example: "Message delivered successfully",
   })
   @Column({
     nullable: true,
@@ -231,6 +238,7 @@ export default class SmsLog extends BaseModel {
     title: "Status of the SMS",
     description: "Status of the SMS sent",
     canReadOnRelationQuery: false,
+    example: "Delivered",
   })
   @Column({
     nullable: false,
@@ -257,6 +265,7 @@ export default class SmsLog extends BaseModel {
     canReadOnRelationQuery: false,
     isDefaultValueColumn: true,
     defaultValue: 0,
+    example: 75,
   })
   @Column({
     nullable: false,
@@ -283,6 +292,7 @@ export default class SmsLog extends BaseModel {
     modelType: Incident,
     title: "Incident",
     description: "Incident associated with this SMS (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @ManyToOne(
     () => {
@@ -315,6 +325,7 @@ export default class SmsLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Incident ID",
     description: "ID of Incident associated with this SMS (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -339,6 +350,7 @@ export default class SmsLog extends BaseModel {
     modelType: User,
     title: "User",
     description: "User who initiated this SMS (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @ManyToOne(
     () => {
@@ -371,6 +383,7 @@ export default class SmsLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of User who initiated this SMS (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -395,6 +408,7 @@ export default class SmsLog extends BaseModel {
     modelType: Alert,
     title: "Alert",
     description: "Alert associated with this SMS (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @ManyToOne(
     () => {
@@ -427,6 +441,7 @@ export default class SmsLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Alert ID",
     description: "ID of Alert associated with this SMS (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -451,6 +466,7 @@ export default class SmsLog extends BaseModel {
     modelType: ScheduledMaintenance,
     title: "Scheduled Maintenance",
     description: "Scheduled Maintenance associated with this SMS (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @ManyToOne(
     () => {
@@ -484,6 +500,7 @@ export default class SmsLog extends BaseModel {
     title: "Scheduled Maintenance ID",
     description:
       "ID of Scheduled Maintenance associated with this SMS (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -508,6 +525,7 @@ export default class SmsLog extends BaseModel {
     modelType: StatusPage,
     title: "Status Page",
     description: "Status Page associated with this SMS (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @ManyToOne(
     () => {
@@ -540,6 +558,7 @@ export default class SmsLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Status Page ID",
     description: "ID of Status Page associated with this SMS (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -564,6 +583,7 @@ export default class SmsLog extends BaseModel {
     modelType: StatusPageAnnouncement,
     title: "Status Page Announcement",
     description: "Status Page Announcement associated with this SMS (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @ManyToOne(
     () => {
@@ -597,6 +617,7 @@ export default class SmsLog extends BaseModel {
     title: "Status Page Announcement ID",
     description:
       "ID of Status Page Announcement associated with this SMS (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -621,6 +642,7 @@ export default class SmsLog extends BaseModel {
     modelType: OnCallDutyPolicy,
     title: "On-Call Duty Policy",
     description: "On-Call Duty Policy associated with this SMS (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @ManyToOne(
     () => {
@@ -653,6 +675,7 @@ export default class SmsLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "On-Call Duty Policy ID",
     description: "ID of On-Call Duty Policy associated with this SMS (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -678,6 +701,7 @@ export default class SmsLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule",
     description:
       "On-Call Duty Policy Escalation Rule associated with this SMS (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @ManyToOne(
     () => {
@@ -712,6 +736,7 @@ export default class SmsLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule ID",
     description:
       "ID of On-Call Duty Policy Escalation Rule associated with this SMS (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -737,6 +762,7 @@ export default class SmsLog extends BaseModel {
     title: "On-Call Duty Policy Schedule",
     description:
       "On-Call Duty Policy Schedule associated with this SMS (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @ManyToOne(
     () => {
@@ -770,6 +796,7 @@ export default class SmsLog extends BaseModel {
     title: "On-Call Duty Policy Schedule ID",
     description:
       "ID of On-Call Duty Policy Schedule associated with this SMS (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -794,6 +821,7 @@ export default class SmsLog extends BaseModel {
     modelType: Team,
     title: "Team",
     description: "Team associated with this SMS (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @ManyToOne(
     () => {
@@ -826,6 +854,7 @@ export default class SmsLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of Team associated with this SMS (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -846,6 +875,7 @@ export default class SmsLog extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "f2a3b4c5-0123-abf5-cdef-cdef01234567",
   })
   @ManyToOne(
     () => {
@@ -872,6 +902,7 @@ export default class SmsLog extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "f2a3b4c5-0123-abf5-cdef-cdef01234567",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/StatusPage.ts

@@ -148,6 +148,7 @@ export default class StatusPage 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 StatusPage extends BaseModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "Acme Corp Status Page",
   })
   @Column({
     nullable: false,
@@ -217,6 +219,7 @@ export default class StatusPage extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Page Title",
     description: "Title of your Status Page. This is used for SEO.",
+    example: "Acme Corp System Status",
   })
   @Column({
     nullable: true,
@@ -250,6 +253,8 @@ export default class StatusPage extends BaseModel {
     type: TableColumnType.LongText,
     title: "Page Description",
     description: "Description of your Status Page. This is used for SEO.",
+    example:
+      "Current status and uptime information for all Acme Corp services and infrastructure.",
   })
   @Column({
     nullable: true,
@@ -283,6 +288,7 @@ export default class StatusPage extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "Public status page for Acme Corp customer-facing services",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/StatusPageAnnouncement.ts

@@ -146,6 +146,7 @@ export default class StatusPageAnnouncement 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,
@@ -272,6 +273,7 @@ export default class StatusPageAnnouncement extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Title",
     description: "Title of this resource",
+    example: "Scheduled Maintenance - Database Upgrade",
   })
   @Column({
     nullable: false,
@@ -369,6 +371,8 @@ export default class StatusPageAnnouncement extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Announcement Description",
     description: "Text of the announcement. This can be in Markdown format.",
+    example:
+      "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
   })
   @Column({
     nullable: false,
@@ -481,6 +485,7 @@ export default class StatusPageAnnouncement 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-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/StatusPageAnnouncementTemplate.ts

@@ -107,6 +107,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -144,6 +145,7 @@ export default class StatusPageAnnouncementTemplate 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,
@@ -177,6 +179,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Template Name",
     description: "Name of the announcement template",
+    example: "Planned Upgrade Announcement",
   })
   @Column({
     nullable: false,
@@ -210,6 +213,8 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     type: TableColumnType.LongText,
     title: "Template Description",
     description: "Description of the announcement template",
+    example:
+      "This template is used for announcing planned system upgrades and improvements. It provides subscribers with advance notice of upcoming changes and expected impact on service availability.",
   })
   @Column({
     nullable: true,
@@ -243,6 +248,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Announcement Title",
     description: "Title of the announcement",
+    example: "Scheduled System Upgrade - January 15, 2025",
   })
   @Column({
     nullable: false,
@@ -276,6 +282,8 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Announcement Description",
     description: "Text of the announcement. This is in Markdown.",
+    example:
+      "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
   })
   @Column({
     nullable: false,
@@ -309,6 +317,10 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     modelType: StatusPage,
     title: "Status Pages",
     description: "Status Pages to show this announcement on.",
+    example: [
+      { id: "c3d4e5f6-a7b8-9012-cdef-123456789012" },
+      { id: "d4e5f6a7-b8c9-0123-def1-234567890123" },
+    ],
   })
   @ManyToMany(
     () => {
@@ -356,6 +368,10 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     title: "Monitors",
     description:
       "List of monitors affected by this announcement template. If none are selected, all subscribers will be notified.",
+    example: [
+      { id: "e5f6a7b8-c9d0-1234-ef12-345678901234" },
+      { id: "f6a7b8c9-d0e1-2345-f123-456789012345" },
+    ],
   })
   @ManyToMany(
     () => {
@@ -403,6 +419,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
     description:
       "Should subscribers be notified about announcements created from this template?",
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -427,6 +444,7 @@ export default class StatusPageAnnouncementTemplate 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(
     () => {
@@ -462,6 +480,7 @@ export default class StatusPageAnnouncementTemplate 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,
@@ -487,6 +506,7 @@ export default class StatusPageAnnouncementTemplate 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(
     () => {
@@ -513,6 +533,7 @@ export default class StatusPageAnnouncementTemplate 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/StatusPageDomain.ts

@@ -127,6 +127,7 @@ export default class StatusPageDomain 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,7 +186,11 @@ export default class StatusPageDomain extends BaseModel {
     update: [],
   })
   @Index()
-  @TableColumn({ type: TableColumnType.ObjectID, required: true })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    example: "d4e5f6a7-b8c9-0123-def4-567890abcdef",
+  })
   @Column({
     type: ColumnType.ObjectID,
     nullable: false,
@@ -251,6 +256,7 @@ export default class StatusPageDomain extends BaseModel {
     required: true,
     title: "Status Page ID",
     description: "ID of your Status Page resource where this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -285,6 +291,7 @@ export default class StatusPageDomain extends BaseModel {
     title: "Subdomain",
     description:
       "Subdomain label for your status page such as 'status'. Leave blank or enter @ to use the root domain.",
+    example: "status",
   })
   @Column({
     nullable: false,
@@ -315,6 +322,7 @@ export default class StatusPageDomain extends BaseModel {
     title: "Full Domain",
     description:
       "Full domain of your status page (like status.acmeinc.com). This is autogenerated and is derived from subdomain and domain.",
+    example: "status.acmeinc.com",
   })
   @Column({
     nullable: false,
@@ -380,6 +388,7 @@ export default class StatusPageDomain 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-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/StatusPageFooterLink.ts

@@ -132,6 +132,7 @@ export default class StatusPageFooterLink 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 StatusPageFooterLink extends BaseModel {
     required: true,
     title: "Status Page ID",
     description: "ID of your Status Page resource where this object belongs",
+    example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -231,6 +233,7 @@ export default class StatusPageFooterLink extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Title",
     description: "Title of this resource",
+    example: "Privacy Policy",
   })
   @Column({
     nullable: false,
@@ -264,6 +267,7 @@ export default class StatusPageFooterLink extends BaseModel {
     type: TableColumnType.ShortURL,
     title: "Link",
     description: "URL to a website or any other resource on the internet",
+    example: "https://example.com/privacy",
   })
   @Column({
     nullable: false,
@@ -330,6 +334,7 @@ export default class StatusPageFooterLink 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,
@@ -396,6 +401,7 @@ export default class StatusPageFooterLink extends BaseModel {
     type: TableColumnType.Number,
     title: "Order",
     description: "Order / Priority of this resource",
+    example: 1,
   })
   @Column({
     type: ColumnType.Number,
@@ -412,6 +418,7 @@ export default class StatusPageFooterLink 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,

package/Models/DatabaseModels/StatusPageGroup.ts

@@ -138,6 +138,7 @@ export default class StatusPageGroup 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,
@@ -204,6 +205,7 @@ export default class StatusPageGroup extends BaseModel {
     required: true,
     title: "Status Page ID",
     description: "ID of your Status Page resource where this object belongs",
+    example: "f6a7b8c9-d0e1-2345-6789-abcdef012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -238,6 +240,7 @@ export default class StatusPageGroup extends BaseModel {
     title: "Group Name",
     description: "Name of the Group",
     canReadOnRelationQuery: true,
+    example: "Core Services",
   })
   @Column({
     nullable: false,
@@ -264,6 +267,7 @@ export default class StatusPageGroup extends BaseModel {
     title: "Slug",
     description: "Friendly globally unique name for your object",
     computed: true,
+    example: "core-services",
   })
   @Column({
     nullable: false,
@@ -298,6 +302,8 @@ export default class StatusPageGroup extends BaseModel {
     title: "Description",
     description:
       "Description for this group. This is visible on Status Page. This can be in markdown format.",
+    example:
+      "Critical infrastructure services including API, database, and authentication",
   })
   @Column({
     nullable: true,
@@ -362,6 +368,7 @@ export default class StatusPageGroup extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "f2a3b4c5-d6e7-89ab-cdef-012345678901",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -473,6 +480,7 @@ export default class StatusPageGroup extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "a3b4c5d6-e7f8-9abc-def0-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/StatusPageHeaderLink.ts

@@ -132,6 +132,7 @@ export default class StatusPageHeaderLink 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 StatusPageHeaderLink extends BaseModel {
     required: true,
     title: "Status Page ID",
     description: "ID of your Status Page resource where this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -231,6 +233,7 @@ export default class StatusPageHeaderLink extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Title",
     description: "Title of this resource",
+    example: "Documentation",
   })
   @Column({
     nullable: false,
@@ -264,6 +267,7 @@ export default class StatusPageHeaderLink extends BaseModel {
     type: TableColumnType.ShortURL,
     title: "Link",
     description: "URL to a website or any other resource on the internet",
+    example: "https://docs.example.com",
   })
   @Column({
     nullable: false,
@@ -330,6 +334,7 @@ export default class StatusPageHeaderLink 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-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/StatusPageOwnerTeam.ts

@@ -132,6 +132,7 @@ export default class StatusPageOwnerTeam 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 StatusPageOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "d4e5f6a7-b8c9-0123-d4e5-f6a7b8c90123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -265,6 +267,7 @@ export default class StatusPageOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "StatusPage ID",
     description: "ID of your OneUptime StatusPage in which this object belongs",
+    example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -330,6 +333,7 @@ export default class StatusPageOwnerTeam 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,
@@ -386,6 +390,7 @@ export default class StatusPageOwnerTeam 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,
@@ -414,6 +419,7 @@ export default class StatusPageOwnerTeam extends BaseModel {
     title: "Are Owners Notified",
     description: "Are owners notified of this resource ownership?",
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,