@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/ScheduledMaintenanceTemplate.ts

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

package/Models/DatabaseModels/ServiceCatalog.ts

@@ -151,6 +151,7 @@ export default class ServiceCatalog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -186,6 +187,7 @@ export default class ServiceCatalog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "User Authentication API",
   })
   @Column({
     nullable: false,
@@ -247,6 +249,8 @@ export default class ServiceCatalog extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "RESTful API service that handles user authentication, authorization, and session management for the platform",
   })
   @Column({
     nullable: true,
@@ -314,6 +318,7 @@ export default class ServiceCatalog extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -372,6 +377,7 @@ export default class ServiceCatalog extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/ServiceCatalogDependency.ts

@@ -100,6 +100,7 @@ export default class ServiceCatlogDependency 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 ServiceCatlogDependency 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 ServiceCatlogDependency 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 ServiceCatlogDependency 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,
@@ -239,6 +243,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Service Catalog",
     description:
       "Relation to Service Catalog Resource in which this object belongs",
+    example: "a7b8c9d0-e1f2-3456-ab78-cd90ef123456",
   })
   @ManyToOne(
     () => {
@@ -278,6 +283,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Dependency Service Catalog ID",
     description:
       "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "a7b8c9d0-e1f2-3456-ab78-cd90ef123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -309,6 +315,7 @@ export default class ServiceCatlogDependency 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(
     () => {
@@ -345,6 +352,7 @@ export default class ServiceCatlogDependency 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,
@@ -371,6 +379,7 @@ export default class ServiceCatlogDependency 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(
     () => {
@@ -403,6 +412,7 @@ export default class ServiceCatlogDependency 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/ServiceCatalogMonitor.ts

@@ -100,6 +100,7 @@ export default class ServiceCatalogMonitor 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 ServiceCatalogMonitor 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 ServiceCatalogMonitor 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 ServiceCatalogMonitor 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 ServiceCatalogMonitor extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor in which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
   })
   @ManyToOne(
     () => {
@@ -276,6 +281,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Monitor ID",
     description: "ID of your Monitorin which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -307,6 +313,7 @@ export default class ServiceCatalogMonitor 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 ServiceCatalogMonitor 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 ServiceCatalogMonitor 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 ServiceCatalogMonitor 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/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,