@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/MonitorFeed.ts

@@ -92,6 +92,7 @@ export default class MonitorFeed extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -129,6 +130,7 @@ export default class MonitorFeed extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -158,6 +160,7 @@ export default class MonitorFeed extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor in which this resource belongs",
+    example: "e5f6a7b8-d9c0-1234-5678-901234efab56",
   })
   @ManyToOne(
     () => {
@@ -194,6 +197,7 @@ export default class MonitorFeed extends BaseModel {
     required: true,
     title: "Monitor ID",
     description: "Relation to Monitor ID in which this resource belongs",
+    example: "e5f6a7b8-d9c0-1234-5678-901234efab56",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -224,6 +228,7 @@ export default class MonitorFeed extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "b2c3d4e5-a6b7-8901-2345-678901bcdef0",
   })
   @ManyToOne(
     () => {
@@ -259,6 +264,7 @@ export default class MonitorFeed extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "b2c3d4e5-a6b7-8901-2345-678901bcdef0",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -279,6 +285,7 @@ export default class MonitorFeed extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "c3d4e5f6-b7c8-9012-3456-789012cdef01",
   })
   @ManyToOne(
     () => {
@@ -305,6 +312,7 @@ export default class MonitorFeed extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "c3d4e5f6-b7c8-9012-3456-789012cdef01",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -333,6 +341,8 @@ export default class MonitorFeed extends BaseModel {
     required: true,
     title: "Log (in Markdown)",
     description: "Log of the entire monitor state change in Markdown",
+    example:
+      "**Monitor Status Changed**: Status changed from `Operational` to `Degraded` - Response time exceeded threshold",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -361,6 +371,8 @@ export default class MonitorFeed extends BaseModel {
     required: false,
     title: "More Information (in Markdown)",
     description: "More information in Markdown",
+    example:
+      "### Additional Context\n\nAverage response time: 2500ms (threshold: 2000ms)\nAffected endpoints: `/api/users`, `/api/products`",
   })
   @Column({
     type: ColumnType.Markdown,
@@ -389,6 +401,7 @@ export default class MonitorFeed extends BaseModel {
     required: true,
     title: "Monitor Feed Event",
     description: "Monitor Feed Event",
+    example: "MonitorStatusChanged",
   })
   @Column({
     type: ColumnType.ShortText,
@@ -417,6 +430,7 @@ export default class MonitorFeed extends BaseModel {
     required: true,
     title: "Color",
     description: "Display color for the monitor log",
+    example: "#3498db",
   })
   @Column({
     type: ColumnType.Color,
@@ -449,6 +463,7 @@ export default class MonitorFeed extends BaseModel {
     title: "User",
     description:
       "Relation to User who this feed belongs to (if this feed belongs to a User)",
+    example: "d4e5f6a7-c8d9-0123-4567-890123def012",
   })
   @ManyToOne(
     () => {
@@ -484,6 +499,7 @@ export default class MonitorFeed extends BaseModel {
     title: "User ID",
     description:
       "User who this feed belongs to (if this feed belongs to a User)",
+    example: "d4e5f6a7-c8d9-0123-4567-890123def012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -511,6 +527,7 @@ export default class MonitorFeed 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/MonitorGroup.ts

@@ -144,6 +144,7 @@ export default class MonitorGroup 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,
@@ -179,6 +180,7 @@ export default class MonitorGroup extends BaseModel {
     title: "Name",
     description: "Any friendly name for this monitor group",
     canReadOnRelationQuery: true,
+    example: "Production Servers",
   })
   @Column({
     nullable: false,
@@ -212,6 +214,7 @@ export default class MonitorGroup extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "All production servers and services that need 24/7 monitoring",
   })
   @Column({
     nullable: true,
@@ -304,6 +307,7 @@ export default class MonitorGroup 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,
@@ -350,6 +354,7 @@ export default class MonitorGroup 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/MonitorGroupOwnerTeam.ts

@@ -94,6 +94,7 @@ export default class MonitorGroupOwnerTeam 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 MonitorGroupOwnerTeam 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 MonitorGroupOwnerTeam extends BaseModel {
     title: "Team",
     description:
       "Team that is the owner. All users in this team will receive notifications. ",
+    example: "c2d3e4f5-a6b7-8c9d-0e1f-2a3b4c5d6e7f",
   })
   @ManyToOne(
     () => {
@@ -198,6 +201,7 @@ export default class MonitorGroupOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "c2d3e4f5-a6b7-8c9d-0e1f-2a3b4c5d6e7f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -228,6 +232,7 @@ export default class MonitorGroupOwnerTeam extends BaseModel {
     title: "MonitorGroup",
     description:
       "Relation to MonitorGroup Resource in which this object belongs",
+    example: "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
   })
   @ManyToOne(
     () => {
@@ -266,6 +271,7 @@ export default class MonitorGroupOwnerTeam extends BaseModel {
     title: "MonitorGroup ID",
     description:
       "ID of your OneUptime MonitorGroup in which this object belongs",
+    example: "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -296,6 +302,7 @@ export default class MonitorGroupOwnerTeam extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @ManyToOne(
     () => {
@@ -331,6 +338,7 @@ export default class MonitorGroupOwnerTeam extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -356,6 +364,7 @@ export default class MonitorGroupOwnerTeam extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @ManyToOne(
     () => {
@@ -387,6 +396,7 @@ export default class MonitorGroupOwnerTeam extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -415,6 +425,7 @@ export default class MonitorGroupOwnerTeam 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/MonitorGroupOwnerUser.ts

@@ -93,6 +93,7 @@ export default class MonitorGroupOwnerUser 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 MonitorGroupOwnerUser 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 MonitorGroupOwnerUser extends BaseModel {
     title: "User",
     description:
       "User that is the owner. This user will receive notifications. ",
+    example: "d3e4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @ManyToOne(
     () => {
@@ -197,6 +200,7 @@ export default class MonitorGroupOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of your OneUptime User in which this object belongs",
+    example: "d3e4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -227,6 +231,7 @@ export default class MonitorGroupOwnerUser extends BaseModel {
     title: "MonitorGroup",
     description:
       "Relation to MonitorGroup Resource in which this object belongs",
+    example: "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
   })
   @ManyToOne(
     () => {
@@ -265,6 +270,7 @@ export default class MonitorGroupOwnerUser extends BaseModel {
     title: "MonitorGroup ID",
     description:
       "ID of your OneUptime MonitorGroup in which this object belongs",
+    example: "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -295,6 +301,7 @@ export default class MonitorGroupOwnerUser extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @ManyToOne(
     () => {
@@ -330,6 +337,7 @@ export default class MonitorGroupOwnerUser extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -355,6 +363,7 @@ export default class MonitorGroupOwnerUser extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @ManyToOne(
     () => {
@@ -386,6 +395,7 @@ export default class MonitorGroupOwnerUser extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -414,6 +424,7 @@ export default class MonitorGroupOwnerUser 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/MonitorGroupResource.ts

@@ -88,6 +88,7 @@ export default class MonitorGroupResource extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -125,6 +126,7 @@ export default class MonitorGroupResource 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,
@@ -155,6 +157,7 @@ export default class MonitorGroupResource extends BaseModel {
     title: "Monitor Group",
     description:
       "Relation to Monitor Group Resource in which this object belongs",
+    example: "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
   })
   @ManyToOne(
     () => {
@@ -191,6 +194,7 @@ export default class MonitorGroupResource extends BaseModel {
     required: true,
     title: "Monitor Group ID",
     description: "ID of your Monitor Group resource where this object belongs",
+    example: "b1c2d3e4-f5a6-7b8c-9d0e-1f2a3b4c5d6e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -225,6 +229,7 @@ export default class MonitorGroupResource extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor Resource in which this object belongs",
+    example: "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
   })
   @ManyToOne(
     () => {
@@ -266,6 +271,7 @@ export default class MonitorGroupResource extends BaseModel {
     required: true,
     title: "Monitor ID",
     description: "Relation to Monitor ID Resource in which this object belongs",
+    example: "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -296,6 +302,7 @@ export default class MonitorGroupResource extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @ManyToOne(
     () => {
@@ -331,6 +338,7 @@ export default class MonitorGroupResource extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -351,6 +359,7 @@ export default class MonitorGroupResource extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @ManyToOne(
     () => {
@@ -377,6 +386,7 @@ export default class MonitorGroupResource extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/MonitorOwnerTeam.ts

@@ -95,6 +95,7 @@ export default class MonitorOwnerTeam 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(
     () => {
@@ -132,6 +133,7 @@ export default class MonitorOwnerTeam 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,
@@ -162,6 +164,7 @@ export default class MonitorOwnerTeam extends BaseModel {
     title: "Team",
     description:
       "Team that is the owner. All users in this team will receive notifications. ",
+    example: "team-id-7a9d1e2f-b3c4-5d6e-9f0a-1b2c3d4e5f6a",
   })
   @ManyToOne(
     () => {
@@ -199,6 +202,7 @@ export default class MonitorOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of your OneUptime Team in which this object belongs",
+    example: "7a9d1e2f-b3c4-5d6e-9f0a-1b2c3d4e5f6a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -228,6 +232,7 @@ export default class MonitorOwnerTeam extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor Resource in which this object belongs",
+    example: "monitor-id-3c5e7f9a-d1b2-4e6a-8f9c-0d1e2f3a4b5c",
   })
   @ManyToOne(
     () => {
@@ -265,6 +270,7 @@ export default class MonitorOwnerTeam extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Monitor ID",
     description: "ID of your OneUptime Monitor in which this object belongs",
+    example: "3c5e7f9a-d1b2-4e6a-8f9c-0d1e2f3a4b5c",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -295,6 +301,7 @@ export default class MonitorOwnerTeam 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(
     () => {
@@ -330,6 +337,7 @@ export default class MonitorOwnerTeam 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,
@@ -355,6 +363,7 @@ export default class MonitorOwnerTeam 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(
     () => {
@@ -386,6 +395,7 @@ export default class MonitorOwnerTeam 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,
@@ -417,6 +427,7 @@ export default class MonitorOwnerTeam 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/MonitorOwnerUser.ts

@@ -94,6 +94,7 @@ export default class MonitorOwnerUser 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(
     () => {
@@ -131,6 +132,7 @@ export default class MonitorOwnerUser 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 MonitorOwnerUser extends BaseModel {
     title: "User",
     description:
       "User that is the owner. This user will receive notifications. ",
+    example: "user-id-8c1d3e5f-a7b9-4c2e-9d6f-1a2b3c4d5e6f",
   })
   @ManyToOne(
     () => {
@@ -198,6 +201,7 @@ export default class MonitorOwnerUser 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,
@@ -227,6 +231,7 @@ export default class MonitorOwnerUser extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor Resource in which this object belongs",
+    example: "monitor-id-3c5e7f9a-d1b2-4e6a-8f9c-0d1e2f3a4b5c",
   })
   @ManyToOne(
     () => {
@@ -264,6 +269,7 @@ export default class MonitorOwnerUser extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Monitor ID",
     description: "ID of your OneUptime Monitor in which this object belongs",
+    example: "3c5e7f9a-d1b2-4e6a-8f9c-0d1e2f3a4b5c",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -294,6 +300,7 @@ export default class MonitorOwnerUser 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(
     () => {
@@ -329,6 +336,7 @@ export default class MonitorOwnerUser 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,
@@ -354,6 +362,7 @@ export default class MonitorOwnerUser 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(
     () => {
@@ -385,6 +394,7 @@ export default class MonitorOwnerUser 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,
@@ -416,6 +426,7 @@ export default class MonitorOwnerUser 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/MonitorProbe.ts

@@ -82,6 +82,7 @@ export default class MonitorProbe extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -118,6 +119,7 @@ export default class MonitorProbe 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,
@@ -146,6 +148,7 @@ export default class MonitorProbe extends BaseModel {
     modelType: Probe,
     title: "Probe",
     description: "Relation to Probe Resource in which this object belongs",
+    example: "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
   })
   @ManyToOne(
     () => {
@@ -182,6 +185,7 @@ export default class MonitorProbe extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Probe ID",
     description: "ID of your OneUptime Probe in which this object belongs",
+    example: "a1b2c3d4-e5f6-7890-ab12-cd3456ef7890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -210,6 +214,7 @@ export default class MonitorProbe extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor Resource in which this object belongs",
+    example: "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
   })
   @ManyToOne(
     () => {
@@ -246,6 +251,7 @@ export default class MonitorProbe extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Monitor ID",
     description: "ID of your OneUptime Monitor in which this object belongs",
+    example: "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -270,7 +276,10 @@ export default class MonitorProbe extends BaseModel {
 
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Date })
+  @TableColumn({
+    type: TableColumnType.Date,
+    example: "2024-01-15T10:30:00.000Z",
+  })
   @Column({
     type: ColumnType.Date,
     nullable: true,
@@ -293,7 +302,10 @@ export default class MonitorProbe extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Date })
+  @TableColumn({
+    type: TableColumnType.Date,
+    example: "2024-01-15T10:35:00.000Z",
+  })
   @Column({
     type: ColumnType.Date,
     nullable: true,
@@ -322,6 +334,7 @@ export default class MonitorProbe extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @ManyToOne(
     () => {
@@ -356,6 +369,7 @@ export default class MonitorProbe extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "3d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -381,6 +395,7 @@ export default class MonitorProbe extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @ManyToOne(
     () => {
@@ -412,6 +427,7 @@ export default class MonitorProbe extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "4e5f6a7b-8c9d-0e1f-2a3b-4c5d6e7f8a9b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -444,6 +460,7 @@ export default class MonitorProbe extends BaseModel {
     required: true,
     type: TableColumnType.Boolean,
     defaultValue: true,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -467,6 +484,13 @@ export default class MonitorProbe extends BaseModel {
     isDefaultValueColumn: false,
     required: false,
     type: TableColumnType.JSON,
+    example: {
+      "step-1": {
+        isSuccess: true,
+        responseTimeInMs: 245,
+        statusCode: 200,
+      },
+    },
   })
   @Column({
     type: ColumnType.JSON,