@oneuptime/common 9.2.15 → 9.2.17

package/Models/DatabaseModels/TeamMember.ts

@@ -95,6 +95,7 @@ export default class TeamMember extends BaseModel {
     modelType: Team,
     title: "Team",
     description: "Team this permission belongs in.",
+    example: "Engineering Team",
   })
   @ManyToOne(
     () => {
@@ -131,6 +132,7 @@ export default class TeamMember extends BaseModel {
     type: TableColumnType.ObjectID,
     title: "Team ID",
     description: "ID of Team this user belongs to.",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -161,6 +163,7 @@ export default class TeamMember extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "My Production Project",
   })
   @ManyToOne(
     () => {
@@ -199,6 +202,7 @@ export default class TeamMember extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -228,6 +232,7 @@ export default class TeamMember extends BaseModel {
     modelType: User,
     title: "User",
     description: "User who belongs to this team.",
+    example: "john.doe@company.com",
   })
   @ManyToOne(
     () => {
@@ -264,6 +269,7 @@ export default class TeamMember extends BaseModel {
     required: true,
     title: "User ID",
     description: "ID of User who belongs to this team",
+    example: "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -284,6 +290,7 @@ export default class TeamMember extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "admin@company.com",
   })
   @ManyToOne(
     () => {
@@ -309,6 +316,7 @@ export default class TeamMember extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "c8f5e0a2-d4b7-4a8d-9e3f-2a3b4c5d6e7f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -329,6 +337,7 @@ export default class TeamMember extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "admin@company.com",
   })
   @ManyToOne(
     () => {
@@ -355,6 +364,7 @@ export default class TeamMember extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d9a6f1b3-e5c8-4b9e-af4d-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -386,6 +396,7 @@ export default class TeamMember extends BaseModel {
     title: "Has Accepted Invitation",
     description: "Has this team member accepted invitation",
     defaultValue: false,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -414,6 +425,7 @@ export default class TeamMember extends BaseModel {
     type: TableColumnType.Date,
     title: "Accepted Invitation At",
     description: "When did this team member accept invitation",
+    example: "2024-01-15T10:30:00Z",
   })
   @Column({
     type: ColumnType.Date,

package/Models/DatabaseModels/TeamPermission.ts

@@ -104,6 +104,7 @@ export default class TeamPermission extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "My Production Project",
   })
   @ManyToOne(
     () => {
@@ -141,6 +142,7 @@ export default class TeamPermission extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -170,6 +172,7 @@ export default class TeamPermission extends BaseModel {
     modelType: Team,
     title: "Team",
     description: "Team this permission belongs in.",
+    example: "Engineering Team",
   })
   @ManyToOne(
     () => {
@@ -205,6 +208,7 @@ export default class TeamPermission extends BaseModel {
     type: TableColumnType.ObjectID,
     title: "Team ID",
     description: "ID of Team this permission belongs in.",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -234,6 +238,7 @@ export default class TeamPermission extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "admin@company.com",
   })
   @ManyToOne(
     () => {
@@ -268,6 +273,7 @@ export default class TeamPermission extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "c8f5e0a2-d4b7-4a8d-9e3f-2a3b4c5d6e7f",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -297,6 +303,7 @@ export default class TeamPermission extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "admin@company.com",
   })
   @ManyToOne(
     () => {
@@ -323,6 +330,7 @@ export default class TeamPermission extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d9a6f1b3-e5c8-4b9e-af4d-3b4c5d6e7f8a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -358,6 +366,7 @@ export default class TeamPermission extends BaseModel {
     title: "Permission",
     description:
       "Permission. You can find list of permissions on the Permissions page.",
+    example: "ProjectOwner",
   })
   @Column({
     nullable: false,
@@ -392,6 +401,7 @@ export default class TeamPermission extends BaseModel {
     modelType: Label,
     title: "Labels",
     description: "Relation to Labels Array where this permission is scoped at.",
+    example: [{ name: "Production" }, { name: "Critical" }],
   })
   @ManyToMany(
     () => {
@@ -436,6 +446,7 @@ export default class TeamPermission extends BaseModel {
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/TelemetryException.ts

@@ -77,6 +77,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -113,6 +114,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     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 TelemetryException extends DatabaseBaseModel {
     title: "Telemetry Service",
     description:
       "Relation to Telemetry Service Resource in which this object belongs",
+    example: "d4e5f6a7-b8c9-0123-def1-234567890123",
   })
   @ManyToOne(
     () => {
@@ -186,6 +189,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     title: "Telemetry Service ID",
     description:
       "ID of your Telemetry Service resource where this object belongs",
+    example: "d4e5f6a7-b8c9-0123-def1-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -218,6 +222,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     canReadOnRelationQuery: false,
     title: "Exception Message",
     description: "Exception message that was thrown by the telemetry service",
+    example: "NullPointerException: Cannot read property 'id' of null",
   })
   @Column({
     nullable: true,
@@ -250,6 +255,8 @@ export default class TelemetryException extends DatabaseBaseModel {
     title: "Stack Trace",
     description:
       "Stack trace of the exception that was thrown by the telemetry service",
+    example:
+      "at getUserData (/app/src/services/user.js:42:15)\nat processRequest (/app/src/controllers/user.js:89:20)",
   })
   @Column({
     nullable: true,
@@ -282,6 +289,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     title: "Exception Type",
     description:
       "Type of the exception that was thrown by the telemetry service",
+    example: "NullPointerException",
   })
   @Column({
     nullable: true,
@@ -315,6 +323,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     title: "Finger Print",
     description:
       "Finger print of the exception that was thrown by the telemetry service",
+    example: "a8b7c6d5e4f3g2h1",
   })
   @Column({
     nullable: true,
@@ -344,6 +353,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     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(
     () => {
@@ -378,6 +388,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     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,
@@ -411,6 +422,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     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(
     () => {
@@ -450,6 +462,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     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,
@@ -481,6 +494,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.Date,
     title: "Accepted Invitation At",
     description: "When did this team member accept invitation",
+    example: "2025-12-12T14:30:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -512,6 +526,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.Date,
     title: "Accepted Invitation At",
     description: "When did this team member accept invitation",
+    example: "2025-12-12T15:45:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -543,6 +558,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.Date,
     title: "Accepted Invitation At",
     description: "When did this team member accept invitation",
+    example: "2025-12-10T08:15:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -574,6 +590,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.Date,
     title: "Accepted Invitation At",
     description: "When did this team member accept invitation",
+    example: "2025-12-12T16:20:00.000Z",
   })
   @Column({
     type: ColumnType.Date,
@@ -607,6 +624,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     modelType: User,
     title: "Assign to User",
     description: "Relation to User who this exception is assigned to.",
+    example: "e5f6a7b8-c9d0-1234-efgh-234567890124",
   })
   @ManyToOne(
     () => {
@@ -645,6 +663,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.ObjectID,
     title: "Assign to User ID",
     description: "User ID who this exception is assigned to.",
+    example: "e5f6a7b8-c9d0-1234-efgh-234567890124",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -680,6 +699,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     modelType: Team,
     title: "Assign to Team",
     description: "Relation to Team who this exception is assigned to.",
+    example: "f6a7b8c9-d0e1-2345-fghi-345678901235",
   })
   @ManyToOne(
     () => {
@@ -718,6 +738,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.ObjectID,
     title: "Assign to Team ID",
     description: "Team ID who this exception is assigned to.",
+    example: "f6a7b8c9-d0e1-2345-fghi-345678901235",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -753,6 +774,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     title: "Marked as Resolved By User",
     description:
       "Mark as resolved by User who marked this exception as resolved.",
+    example: "a7b8c9d0-e1f2-3456-ghij-456789012346",
   })
   @ManyToOne(
     () => {
@@ -791,6 +813,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.ObjectID,
     title: "Marked as Resolved By User ID",
     description: "User ID who marked this exception as resolved.",
+    example: "a7b8c9d0-e1f2-3456-ghij-456789012346",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -825,6 +848,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     modelType: User,
     title: "Mark as Archived By User",
     description: "Mark as archived by User",
+    example: "b8c9d0e1-f2a3-4567-hijk-567890123457",
   })
   @ManyToOne(
     () => {
@@ -863,6 +887,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     type: TableColumnType.ObjectID,
     title: "Mark as Archived By User ID",
     description: "User ID who marked this exception as archived.",
+    example: "b8c9d0e1-f2a3-4567-hijk-567890123457",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -896,6 +921,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     required: true,
     type: TableColumnType.Boolean,
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -930,6 +956,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     required: true,
     type: TableColumnType.Boolean,
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -964,6 +991,7 @@ export default class TelemetryException extends DatabaseBaseModel {
     required: true,
     type: TableColumnType.Number,
     defaultValue: 1,
+    example: 42,
   })
   @Column({
     type: ColumnType.Number,

package/Models/DatabaseModels/TelemetryIngestionKey.ts

@@ -72,6 +72,7 @@ export default class TelemetryIngestionKey extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -107,6 +108,7 @@ export default class TelemetryIngestionKey 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,
@@ -139,6 +141,7 @@ export default class TelemetryIngestionKey extends BaseModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "Production Telemetry Key",
   })
   @Column({
     nullable: false,
@@ -169,6 +172,8 @@ export default class TelemetryIngestionKey extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "This key is used for ingesting telemetry data from production services",
   })
   @Column({
     nullable: true,
@@ -197,6 +202,7 @@ export default class TelemetryIngestionKey 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(
     () => {
@@ -230,6 +236,7 @@ export default class TelemetryIngestionKey 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,
@@ -250,6 +257,7 @@ export default class TelemetryIngestionKey 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(
     () => {
@@ -276,6 +284,7 @@ export default class TelemetryIngestionKey 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,
@@ -304,6 +313,7 @@ export default class TelemetryIngestionKey extends BaseModel {
     computed: true,
     title: "Telemetry Ingestion Key",
     description: "Secret Telemetry Ingestion Key",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/TelemetryService.ts

@@ -142,6 +142,7 @@ export default class TelemetryService 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 +178,7 @@ export default class TelemetryService extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Payment API Service",
   })
   @Column({
     nullable: false,
@@ -238,6 +240,7 @@ export default class TelemetryService extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "Telemetry and monitoring for the payment processing API service",
   })
   @Column({
     nullable: true,
@@ -305,6 +308,7 @@ export default class TelemetryService 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,
@@ -363,6 +367,7 @@ export default class TelemetryService 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-f2345678901a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -443,6 +448,7 @@ export default class TelemetryService extends BaseModel {
     computed: true,
     title: "Service Token",
     description: "Service Token for this telemetry service",
+    example: "e5f6a7b8-c9d0-1234-efab-56789012cdef",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/TelemetryUsageBilling.ts

@@ -60,6 +60,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -91,6 +92,7 @@ export default class TelemetryUsageBilling 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,
@@ -114,6 +116,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Day",
     description: "Day of the month this usage billing was generated for",
+    example: "12-12-2025",
   })
   @Column({
     nullable: false,
@@ -137,6 +140,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Product Type",
     description: "Product Type this usage billing was generated for",
+    example: "Logs",
   })
   @Column({
     nullable: false,
@@ -163,6 +167,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     title: "Retain Telemetry Data For Days",
     description: "Number of days to retain telemetry data for this service.",
     defaultValue: DEFAULT_RETENTION_IN_DAYS,
+    example: 30,
   })
   @Column({
     type: ColumnType.Number,
@@ -187,6 +192,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Data Ingested (in GB)",
     description: "Data Ingested in GB this usage billing was generated for",
+    example: 125.5,
   })
   @Column({
     nullable: false,
@@ -210,6 +216,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Total Cost in USD",
     description: "Total Cost in USD this usage billing was generated for",
+    example: 45.99,
   })
   @Column({
     nullable: false,
@@ -230,6 +237,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     title: "Reported to Billing Provider",
     description:
       "Whether this usage billing was reported to billing provider or not (eg Stripe)",
+    example: true,
   })
   @Column({
     nullable: false,
@@ -254,6 +262,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     title: "Telemetry Service",
     description:
       "Relation to Telemetry Service Resource in which this object belongs",
+    example: "d4e5f6a7-b8c9-0123-def1-234567890123",
   })
   @ManyToOne(
     () => {
@@ -285,6 +294,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     title: "Telemetry Service ID",
     description:
       "ID of your Telemetry Service resource where this object belongs",
+    example: "d4e5f6a7-b8c9-0123-def1-234567890123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -305,6 +315,7 @@ export default class TelemetryUsageBilling extends BaseModel {
     title: "Reported to Billing Provider At",
     description:
       "When this usage billing was reported to billing provider or not (eg Stripe)",
+    example: "2025-12-12T10:00:00.000Z",
   })
   @Column({
     nullable: true,
@@ -328,6 +339,7 @@ export default class TelemetryUsageBilling 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(
     () => {
@@ -357,6 +369,7 @@ export default class TelemetryUsageBilling 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,
@@ -381,6 +394,7 @@ export default class TelemetryUsageBilling 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(
     () => {
@@ -411,6 +425,7 @@ export default class TelemetryUsageBilling 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/User.ts

@@ -54,7 +54,11 @@ class User extends UserModel {
     read: [Permission.CurrentUser],
     update: [Permission.CurrentUser],
   })
-  @TableColumn({ type: TableColumnType.Name, canReadOnRelationQuery: true })
+  @TableColumn({
+    type: TableColumnType.Name,
+    canReadOnRelationQuery: true,
+    example: "John Smith",
+  })
   @Column({
     type: ColumnType.Name,
     length: ColumnLength.Name,
@@ -76,6 +80,7 @@ class User extends UserModel {
     unique: true,
     type: TableColumnType.Email,
     canReadOnRelationQuery: true,
+    example: "john.smith@company.com",
   })
   @Column({
     type: ColumnType.Email,
@@ -115,6 +120,7 @@ class User extends UserModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "john-smith",
   })
   @Column({
     nullable: false,
@@ -271,6 +277,7 @@ class User extends UserModel {
   @TableColumn({
     type: TableColumnType.ObjectID,
     canReadOnRelationQuery: true,
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -666,6 +673,7 @@ class User extends UserModel {
     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,