@oneuptime/common 9.2.15 → 9.2.17

package/Models/DatabaseModels/ServiceCatalogOwnerTeam.ts

@@ -94,6 +94,7 @@ export default class ServiceCatalogOwnerTeam extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -131,6 +132,7 @@ export default class ServiceCatalogOwnerTeam 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 ServiceCatalogOwnerTeam extends BaseModel {
     title: "Team",
     description:
       "Team that is the owner. All users in this team will receive notifications. ",
+    example: "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
   })
   @ManyToOne(
     () => {
@@ -198,6 +201,7 @@ export default class ServiceCatalogOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -228,6 +232,7 @@ export default class ServiceCatalogOwnerTeam extends BaseModel {
     title: "Service Catalog",
     description:
       "Relation to Service Catalog Resource in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @ManyToOne(
     () => {
@@ -266,6 +271,7 @@ export default class ServiceCatalogOwnerTeam extends BaseModel {
     title: "Service Catalog ID",
     description:
       "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -296,6 +302,7 @@ export default class ServiceCatalogOwnerTeam 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-cd34-ef56ab789012",
   })
   @ManyToOne(
     () => {
@@ -331,6 +338,7 @@ export default class ServiceCatalogOwnerTeam 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-cd34-ef56ab789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -356,6 +364,7 @@ export default class ServiceCatalogOwnerTeam extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @ManyToOne(
     () => {
@@ -387,6 +396,7 @@ export default class ServiceCatalogOwnerTeam 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-de45-fa67bc890123",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/ServiceCatalogOwnerUser.ts

@@ -93,6 +93,7 @@ export default class ServiceCatalogOwnerUser 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 ServiceCatalogOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -160,6 +162,7 @@ export default class ServiceCatalogOwnerUser extends BaseModel {
     title: "User",
     description:
       "User that is the owner. This user will receive notifications. ",
+    example: "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
   })
   @ManyToOne(
     () => {
@@ -197,6 +200,7 @@ export default class ServiceCatalogOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of your OneUptime User in which this object belongs",
+    example: "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -227,6 +231,7 @@ export default class ServiceCatalogOwnerUser extends BaseModel {
     title: "Service Catalog",
     description:
       "Relation to Service Catalog Resource in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @ManyToOne(
     () => {
@@ -265,6 +270,7 @@ export default class ServiceCatalogOwnerUser extends BaseModel {
     title: "Service Catalog ID",
     description:
       "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -295,6 +301,7 @@ export default class ServiceCatalogOwnerUser 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-cd34-ef56ab789012",
   })
   @ManyToOne(
     () => {
@@ -330,6 +337,7 @@ export default class ServiceCatalogOwnerUser 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-cd34-ef56ab789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -355,6 +363,7 @@ export default class ServiceCatalogOwnerUser extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @ManyToOne(
     () => {
@@ -386,6 +395,7 @@ export default class ServiceCatalogOwnerUser 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-de45-fa67bc890123",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/ServiceCatalogTelemetryService.ts

@@ -100,6 +100,7 @@ export default class ServiceCatalogTelemetryService extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -138,6 +139,7 @@ export default class ServiceCatalogTelemetryService 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,
@@ -169,6 +171,7 @@ export default class ServiceCatalogTelemetryService extends BaseModel {
     title: "Service Catalog",
     description:
       "Relation to Service Catalog Resource in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @ManyToOne(
     () => {
@@ -208,6 +211,7 @@ export default class ServiceCatalogTelemetryService extends BaseModel {
     title: "Service Catalog ID",
     description:
       "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -238,6 +242,7 @@ export default class ServiceCatalogTelemetryService extends BaseModel {
     modelType: TelemetryService,
     title: "TelemetryService",
     description: "Relation to TelemetryService in which this object belongs",
+    example: "c9d0e1f2-a3b4-5678-cd90-ef12ab345678",
   })
   @ManyToOne(
     () => {
@@ -276,6 +281,7 @@ export default class ServiceCatalogTelemetryService extends BaseModel {
     canReadOnRelationQuery: true,
     title: "TelemetryService ID",
     description: "ID of your TelemetryServicein which this object belongs",
+    example: "c9d0e1f2-a3b4-5678-cd90-ef12ab345678",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -307,6 +313,7 @@ export default class ServiceCatalogTelemetryService 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-cd34-ef56ab789012",
   })
   @ManyToOne(
     () => {
@@ -343,6 +350,7 @@ export default class ServiceCatalogTelemetryService 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-cd34-ef56ab789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -369,6 +377,7 @@ export default class ServiceCatalogTelemetryService extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @ManyToOne(
     () => {
@@ -401,6 +410,7 @@ export default class ServiceCatalogTelemetryService 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-de45-fa67bc890123",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/ShortLink.ts

@@ -45,6 +45,7 @@ export default class ShortLink extends BaseModel {
     title: "Short Link ID",
     description: "Random ID for the short link",
     canReadOnRelationQuery: false,
+    example: "abc123xyz",
   })
   @Column({
     nullable: false,
@@ -64,6 +65,7 @@ export default class ShortLink extends BaseModel {
     title: "Long URL",
     description: "Long URL to redirect to",
     canReadOnRelationQuery: false,
+    example: "https://example.com/redirect/to/this/long/url",
   })
   @Column({
     nullable: false,
@@ -84,6 +86,7 @@ export default class ShortLink 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(
     () => {
@@ -110,6 +113,7 @@ export default class ShortLink 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/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,