@oneuptime/common 9.2.14 → 9.2.16

package/Models/DatabaseModels/ApiKeyPermission.ts

@@ -106,6 +106,7 @@ export default class APIKeyPermission extends BaseModel {
     modelType: ApiKey,
     title: "Api Key",
     description: "Relation to API Key resource in which this object belongs",
+    example: "Production API Key",
   })
   @ManyToOne(
     () => {
@@ -141,6 +142,7 @@ export default class APIKeyPermission extends BaseModel {
     required: true,
     title: "API Key ID",
     description: "ID of API Key resource in which this object belongs",
+    example: "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -169,6 +171,7 @@ export default class APIKeyPermission extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "My Production Project",
   })
   @ManyToOne(
     () => {
@@ -205,6 +208,7 @@ export default class APIKeyPermission 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,
@@ -233,6 +237,7 @@ export default class APIKeyPermission 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(
     () => {
@@ -266,6 +271,7 @@ export default class APIKeyPermission 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,
@@ -294,6 +300,7 @@ export default class APIKeyPermission 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(
     () => {
@@ -320,6 +327,7 @@ export default class APIKeyPermission 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,
@@ -353,6 +361,7 @@ export default class APIKeyPermission extends BaseModel {
     title: "Permission",
     description:
       "Permission. You can find list of permissions on the Permissions page.",
+    example: "ProjectOwner",
   })
   @UniqueColumnBy("apiKeyId")
   @Column({
@@ -387,6 +396,7 @@ export default class APIKeyPermission extends BaseModel {
     modelType: Label,
     title: "Labels",
     description: "Relation to Labels Array where this permission is scoped at.",
+    example: [{ name: "Production" }, { name: "Critical" }],
   })
   @ManyToMany(
     () => {
@@ -430,6 +440,7 @@ export default class APIKeyPermission extends BaseModel {
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/BillingInvoice.ts

@@ -67,6 +67,7 @@ export default class BillingInvoice extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -98,6 +99,7 @@ export default class BillingInvoice 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,
@@ -122,6 +124,7 @@ export default class BillingInvoice 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(
     () => {
@@ -151,6 +154,7 @@ export default class BillingInvoice 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,
@@ -175,6 +179,7 @@ export default class BillingInvoice 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(
     () => {
@@ -205,6 +210,7 @@ export default class BillingInvoice 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,
@@ -222,7 +228,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Number })
+  @TableColumn({
+    type: TableColumnType.Number,
+    example: 9999,
+  })
   @Column({
     type: ColumnType.Decimal,
     nullable: false,
@@ -239,7 +248,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.ShortText })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    example: "USD",
+  })
   @Column({
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
@@ -257,7 +269,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.LongURL })
+  @TableColumn({
+    type: TableColumnType.LongURL,
+    example: "https://invoices.oneuptime.com/download/inv_1234567890",
+  })
   @Column({
     type: ColumnType.LongURL,
     nullable: false,
@@ -275,7 +290,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.ShortText })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    example: "paid",
+  })
   @Column({
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
@@ -293,7 +311,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.ShortText })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    example: "cus_1234567890abcdef",
+  })
   @Column({
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
@@ -311,7 +332,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.ShortText })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    example: "sub_1234567890abcdef",
+  })
   @Column({
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
@@ -329,7 +353,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.ShortText })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    example: "in_1234567890abcdef",
+  })
   @Column({
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
@@ -347,7 +374,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Date })
+  @TableColumn({
+    type: TableColumnType.Date,
+    example: "2024-01-15T00:00:00.000Z",
+  })
   @Column({
     type: ColumnType.Date,
     nullable: true,
@@ -363,7 +393,10 @@ export default class BillingInvoice extends BaseModel {
     ],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.LongText })
+  @TableColumn({
+    type: TableColumnType.LongText,
+    example: "INV-2024-0001",
+  })
   @Column({
     type: ColumnType.LongText,
     length: ColumnLength.LongText,

package/Models/DatabaseModels/CallLog.ts

@@ -76,6 +76,7 @@ export default class CallLog 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 CallLog 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 CallLog extends BaseModel {
     title: "To Number",
     description: "Phone Number Call was sent to",
     canReadOnRelationQuery: false,
+    example: "+1-555-123-4567",
   })
   @Column({
     nullable: false,
@@ -159,6 +162,7 @@ export default class CallLog extends BaseModel {
     title: "From Number",
     description: "Phone Number Call was sent from",
     canReadOnRelationQuery: false,
+    example: "+1-555-999-8888",
   })
   @Column({
     nullable: false,
@@ -184,6 +188,7 @@ export default class CallLog extends BaseModel {
     title: "Call Data",
     description: "Content of the data that was sent in the call",
     canReadOnRelationQuery: false,
+    example: { message: "Alert notification", incidentId: "123" },
   })
   @Column({
     nullable: false,
@@ -207,6 +212,7 @@ export default class CallLog extends BaseModel {
     title: "Status Message",
     description: "Status Message (if any)",
     canReadOnRelationQuery: false,
+    example: "Call completed successfully",
   })
   @Column({
     nullable: true,
@@ -231,6 +237,7 @@ export default class CallLog extends BaseModel {
     title: "Status of the Call",
     description: "Status of the Call sent",
     canReadOnRelationQuery: false,
+    example: "Completed",
   })
   @Column({
     nullable: false,
@@ -257,6 +264,7 @@ export default class CallLog extends BaseModel {
     canReadOnRelationQuery: false,
     isDefaultValueColumn: true,
     defaultValue: 0,
+    example: 150,
   })
   @Column({
     nullable: false,
@@ -283,6 +291,7 @@ export default class CallLog extends BaseModel {
     modelType: Incident,
     title: "Incident",
     description: "Incident associated with this Call (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @ManyToOne(
     () => {
@@ -315,6 +324,7 @@ export default class CallLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Incident ID",
     description: "ID of Incident associated with this Call (if any)",
+    example: "b2c3d4e5-6789-01bc-def2-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -339,6 +349,7 @@ export default class CallLog extends BaseModel {
     modelType: User,
     title: "User",
     description: "User who initiated this Call (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @ManyToOne(
     () => {
@@ -371,6 +382,7 @@ export default class CallLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "User ID",
     description: "ID of User who initiated this Call (if any)",
+    example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -395,6 +407,7 @@ export default class CallLog extends BaseModel {
     modelType: Alert,
     title: "Alert",
     description: "Alert associated with this Call (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @ManyToOne(
     () => {
@@ -427,6 +440,7 @@ export default class CallLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Alert ID",
     description: "ID of Alert associated with this Call (if any)",
+    example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -451,6 +465,7 @@ export default class CallLog extends BaseModel {
     modelType: ScheduledMaintenance,
     title: "Scheduled Maintenance",
     description: "Scheduled Maintenance associated with this Call (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @ManyToOne(
     () => {
@@ -484,6 +499,7 @@ export default class CallLog extends BaseModel {
     title: "Scheduled Maintenance ID",
     description:
       "ID of Scheduled Maintenance associated with this Call (if any)",
+    example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -508,6 +524,7 @@ export default class CallLog extends BaseModel {
     modelType: StatusPage,
     title: "Status Page",
     description: "Status Page associated with this Call (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @ManyToOne(
     () => {
@@ -540,6 +557,7 @@ export default class CallLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Status Page ID",
     description: "ID of Status Page associated with this Call (if any)",
+    example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -564,6 +582,7 @@ export default class CallLog extends BaseModel {
     modelType: StatusPageAnnouncement,
     title: "Status Page Announcement",
     description: "Status Page Announcement associated with this Call (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @ManyToOne(
     () => {
@@ -597,6 +616,7 @@ export default class CallLog extends BaseModel {
     title: "Status Page Announcement ID",
     description:
       "ID of Status Page Announcement associated with this Call (if any)",
+    example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -621,6 +641,7 @@ export default class CallLog extends BaseModel {
     modelType: OnCallDutyPolicy,
     title: "On-Call Duty Policy",
     description: "On-Call Duty Policy associated with this Call (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @ManyToOne(
     () => {
@@ -653,6 +674,7 @@ export default class CallLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "On-Call Duty Policy ID",
     description: "ID of On-Call Duty Policy associated with this Call (if any)",
+    example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -678,6 +700,7 @@ export default class CallLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule",
     description:
       "On-Call Duty Policy Escalation Rule associated with this Call (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @ManyToOne(
     () => {
@@ -712,6 +735,7 @@ export default class CallLog extends BaseModel {
     title: "On-Call Duty Policy Escalation Rule ID",
     description:
       "ID of On-Call Duty Policy Escalation Rule associated with this Call (if any)",
+    example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -737,6 +761,7 @@ export default class CallLog extends BaseModel {
     title: "On-Call Duty Policy Schedule",
     description:
       "On-Call Duty Policy Schedule associated with this Call (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @ManyToOne(
     () => {
@@ -770,6 +795,7 @@ export default class CallLog extends BaseModel {
     title: "On-Call Duty Policy Schedule ID",
     description:
       "ID of On-Call Duty Policy Schedule associated with this Call (if any)",
+    example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -794,6 +820,7 @@ export default class CallLog extends BaseModel {
     modelType: Team,
     title: "Team",
     description: "Team associated with this Call (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @ManyToOne(
     () => {
@@ -826,6 +853,7 @@ export default class CallLog extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Team ID",
     description: "ID of Team associated with this Call (if any)",
+    example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -846,6 +874,7 @@ export default class CallLog 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 +901,7 @@ export default class CallLog 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/Dashboard.ts

@@ -97,6 +97,7 @@ export default class Dashboard extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -133,6 +134,7 @@ export default class Dashboard 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,
@@ -165,6 +167,7 @@ export default class Dashboard extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Name",
     description: "Any friendly name of this object",
+    example: "Production Monitoring Dashboard",
   })
   @Column({
     nullable: false,
@@ -191,6 +194,7 @@ export default class Dashboard extends BaseModel {
     computed: true,
     title: "Slug",
     description: "Friendly globally unique name for your object",
+    example: "production-monitoring-dashboard",
   })
   @Column({
     nullable: false,
@@ -222,6 +226,7 @@ export default class Dashboard extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example: "Dashboard for monitoring production infrastructure and services",
   })
   @Column({
     nullable: true,
@@ -251,6 +256,7 @@ export default class Dashboard extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -285,6 +291,7 @@ export default class Dashboard extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -310,6 +317,7 @@ export default class Dashboard 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(
     () => {
@@ -341,6 +349,7 @@ export default class Dashboard 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,
@@ -376,6 +385,7 @@ export default class Dashboard extends BaseModel {
     title: "Labels",
     description:
       "Relation to Labels Array where this object is categorized in.",
+    example: [{ id: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e" }],
   })
   @ManyToMany(
     () => {
@@ -419,6 +429,7 @@ export default class Dashboard extends BaseModel {
     type: TableColumnType.JSON,
     title: "Dashboard View Config",
     description: "Configuration of Dashboard View",
+    example: { components: [], layout: "grid" },
   })
   @Column({
     nullable: false,

package/Models/DatabaseModels/Domain.ts

@@ -114,6 +114,7 @@ export default class Domain 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 +147,7 @@ export default class Domain extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Domain",
     description: "Domain - acmeinc.com for example.",
+    example: "status.acmeinc.com",
   })
   @Column({
     nullable: false,
@@ -236,6 +238,7 @@ export default class Domain 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,
@@ -292,6 +295,7 @@ export default class Domain 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,
@@ -351,6 +355,7 @@ export default class Domain extends BaseModel {
     title: "Domain Verification Text",
     description:
       "Verification text that you need to add to your domains TXT record to veify the domain.",
+    example: "oneuptime-verify=a1b2c3d4e5f67890abcdef1234567890",
   })
   @Column({
     type: ColumnType.ShortText,