github/oneuptime
1
1
Fork 0
mirror of https://github.com/OneUptime/oneuptime.git synced 2026-04-06 00:32:12 +02:00
Code Issues 193 Packages Projects Releases Wiki Activity

Add example values to various fields in Telemetry and User models for better documentation

Browse Source 
- Updated TelemetryException model with example values for Project, Telemetry Service, Exception Message, Stack Trace, Exception Type, Finger Print, Created by User, and more.
- Enhanced TelemetryIngestionKey model with example values for Project, Name, Description, Created by User, and more.
- Improved TelemetryUsageBilling model with example values for Project, Day, Product Type, Data Ingested, Total Cost, and more.
- Added example values to UserCall model for Project ID, Phone, User ID, Created by User ID, and more.
- Included example values in UserEmail model for Project ID, Email, User ID, Created by User ID, and more.
- Updated UserNotificationRule model with example values for Project ID, User ID, Created by User ID, and various notification types.
- Enhanced UserNotificationSetting model with example values for Project ID, User ID, and various notification settings.
- Improved UserOnCallLog model with example values for User ID, Project ID, On-Call Policy ID, and more.
- Added example values to UserSMS model for Project ID, Phone, User ID, Created by User ID, and more.
This commit is contained in:
Nawaz Dhandala
2025-12-12 21:10:10 +00:00
parent e928328bbb
commit ca5c31fc32
78 changed files with 1147 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
APIReference/Service/Model.ts
View File

@@ -29,6 +29,51 @@ interface ExampleObjects {
simpleListResponseExample: Array<JSONObject>;
}
// Helper function to get a default example value based on column type
function getDefaultExampleForType(
columnType: string | undefined,
columnTitle: string | undefined,
): JSONValue {
const typeStr: string = (columnType || "").toLowerCase();
const title: string = (columnTitle || "").toLowerCase();
if (typeStr.includes("objectid") || typeStr.includes("id")) {
return "550e8400-e29b-41d4-a716-446655440000";
}
if (typeStr.includes("boolean") || typeStr.includes("bool")) {
return true;
}
if (typeStr.includes("number") || typeStr.includes("int") || typeStr.includes("decimal")) {
return 100;
}
if (typeStr.includes("date") || typeStr.includes("time")) {
return "2024-01-15T10:30:00.000Z";
}
if (typeStr.includes("email")) {
return "user@example.com";
}
if (typeStr.includes("phone")) {
return "+1-555-123-4567";
}
if (typeStr.includes("url") || typeStr.includes("link")) {
return "https://example.com";
}
if (typeStr.includes("color")) {
return "#3498db";
}
if (typeStr.includes("markdown") || typeStr.includes("longtext") || typeStr.includes("description")) {
return `Example ${title || "text"} content`;
}
if (typeStr.includes("json") || typeStr.includes("object")) {
return { key: "value" };
}
if (typeStr.includes("array")) {
return [];
}
// Default for text fields
return `Example ${title || "value"}`;
}
// Helper function to generate example objects from column metadata
function generateExampleObjects(
tableColumns: Dictionary<TableColumnMetadata>,
@@ -43,11 +88,22 @@ function generateExampleObjects(
_id: exampleObjectID,
};
// Sort columns to show required first, then alphabetically
// Sort columns: prioritize fields with examples, then required, then alphabetically
const sortedColumnKeys: Array<string> = Object.keys(tableColumns).sort(
(a: string, b: string) => {
const aHasExample: boolean = tableColumns[a]?.example !== undefined;
const bHasExample: boolean = tableColumns[b]?.example !== undefined;
const aRequired: boolean = tableColumns[a]?.required || false;
const bRequired: boolean = tableColumns[b]?.required || false;
// Prioritize fields with examples
if (aHasExample && !bHasExample) {
return -1;
}
if (!aHasExample && bHasExample) {
return 1;
}
// Then prioritize required fields
if (aRequired && !bRequired) {
return -1;
}
@@ -72,38 +128,39 @@ function generateExampleObjects(
column as unknown as JSONObject
)["permissions"] as ColumnAccessControl | undefined;
// Get the example value - use defined example or generate a default
const exampleValue: JSONValue =
column.example !== undefined
? (column.example as JSONValue)
: getDefaultExampleForType(column.type?.toString(), column.title);
// Add to select example (limit to 5 fields for readability)
// Also add the field to response example so response matches select
if (selectCount < 5 && accessControl?.read && accessControl.read.length > 0) {
simpleSelectExample[key] = true;
simpleResponseExample[key] = exampleValue;
selectCount++;
}
// Add to response example with actual example values
if (column.example !== undefined && accessControl?.read && accessControl.read.length > 0) {
simpleResponseExample[key] = column.example as JSONValue;
}
// Add to create example (only fields with create permission and examples)
// Add to create example (only fields with create permission)
if (
createCount < 5 &&
column.example !== undefined &&
accessControl?.create &&
accessControl.create.length > 0 &&
!column.computed
) {
simpleCreateExample[key] = column.example as JSONValue;
simpleCreateExample[key] = exampleValue;
createCount++;
}
// Add to update example (only fields with update permission and examples)
// Add to update example (only fields with update permission)
if (
updateCount < 3 &&
column.example !== undefined &&
accessControl?.update &&
accessControl.update.length > 0 &&
!column.computed
) {
simpleUpdateExample[key] = column.example as JSONValue;
simpleUpdateExample[key] = exampleValue;
updateCount++;
}
}
@@ -111,13 +168,19 @@ function generateExampleObjects(
// Add a query example using the first string/text field with an example
for (const key of sortedColumnKeys) {
const column: TableColumnMetadata | undefined = tableColumns[key];
if (
column?.example !== undefined &&
typeof column.example === "string" &&
column.type?.toString().toLowerCase().includes("text")
) {
simpleQueryExample[key] = column.example;
break;
if (column) {
const exampleValue: JSONValue =
column.example !== undefined
? (column.example as JSONValue)
: getDefaultExampleForType(column.type?.toString(), column.title);
if (
typeof exampleValue === "string" &&
column.type?.toString().toLowerCase().includes("text")
) {
simpleQueryExample[key] = exampleValue;
break;
}
}
}

6
Common/Models/DatabaseModels/AlertCustomField.ts
View File

@@ -120,6 +120,7 @@ export default class AlertCustomField 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,
@@ -152,6 +153,7 @@ export default class AlertCustomField extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "Priority Level",
})
@Column({
nullable: false,
@@ -185,6 +187,7 @@ export default class AlertCustomField extends BaseModel {
title: "Description",
description:
"Friendly description of this custom field that will help you remember",
example: "This field indicates the priority level of the alert (Low, Medium, High, Critical)",
})
@Column({
nullable: true,
@@ -212,6 +215,7 @@ export default class AlertCustomField extends BaseModel {
type: TableColumnType.CustomFieldType,
title: "Custom Field Type",
description: "Is this field Text, Number or Boolean?",
example: "Text",
})
@Column({
nullable: true,
@@ -275,6 +279,7 @@ export default class AlertCustomField extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
})
@Column({
type: ColumnType.ObjectID,
@@ -331,6 +336,7 @@ export default class AlertCustomField extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "b5c4d3e2-f1a0-4b5c-9d8e-7f6a5b4c3d2e",
})
@Column({
type: ColumnType.ObjectID,

8
Common/Models/DatabaseModels/AlertFeed.ts
View File

@@ -136,6 +136,7 @@ export default class AlertFeed 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,
@@ -201,6 +202,7 @@ export default class AlertFeed extends BaseModel {
required: true,
title: "Alert ID",
description: "Relation to Alert ID in which this resource belongs",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@Column({
type: ColumnType.ObjectID,
@@ -266,6 +268,7 @@ export default class AlertFeed extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-345678901234",
})
@Column({
type: ColumnType.ObjectID,
@@ -340,6 +343,7 @@ export default class AlertFeed extends BaseModel {
required: true,
title: "Log (in Markdown)",
description: "Log of the entire alert state change in Markdown",
example: "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
})
@Column({
type: ColumnType.Markdown,
@@ -396,6 +400,7 @@ export default class AlertFeed extends BaseModel {
required: true,
title: "Alert Feed Event",
description: "Alert Feed Event",
example: "AlertStateChanged",
})
@Column({
type: ColumnType.ShortText,
@@ -425,6 +430,7 @@ export default class AlertFeed extends BaseModel {
required: true,
title: "Color",
description: "Display color for the alert log",
example: "#e74c3c",
})
@Column({
type: ColumnType.Color,
@@ -492,6 +498,7 @@ export default class AlertFeed extends BaseModel {
title: "User ID",
description:
"User who this feed belongs to (if this feed belongs to a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f23456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -519,6 +526,7 @@ export default class AlertFeed 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,

9
Common/Models/DatabaseModels/AlertNoteTemplate.ts
View File

@@ -93,6 +93,7 @@ export default class AlertNoteTemplate 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 AlertNoteTemplate 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,
@@ -164,6 +166,7 @@ export default class AlertNoteTemplate extends BaseModel {
title: "Note",
description:
"Note template for public or private notes. This is in markdown.",
example: "## Alert Investigation\n\n**Issue**: {{alert.title}}\n\n**Time**: {{alert.createdAt}}\n\n**Analysis**: Initial investigation shows that the alert was triggered due to high CPU usage on the production server. The team is currently investigating the root cause.\n\n**Next Steps**:\n- Monitor system metrics\n- Review application logs\n- Check for memory leaks",
})
@Column({
type: ColumnType.Markdown,
@@ -198,6 +201,7 @@ export default class AlertNoteTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Name of the Alert Template",
example: "Initial Investigation Template",
})
@Column({
nullable: false,
@@ -232,6 +236,7 @@ export default class AlertNoteTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Template Description",
description: "Description of the Alert Template",
example: "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
})
@Column({
nullable: false,
@@ -262,6 +267,7 @@ export default class AlertNoteTemplate 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(
() => {
@@ -297,6 +303,7 @@ export default class AlertNoteTemplate 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,
@@ -317,6 +324,7 @@ export default class AlertNoteTemplate 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(
() => {
@@ -343,6 +351,7 @@ export default class AlertNoteTemplate 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,

11
Common/Models/DatabaseModels/AlertOwnerTeam.ts
View File

@@ -87,6 +87,7 @@ export default class AlertOwnerTeam extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -124,6 +125,7 @@ export default class AlertOwnerTeam 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,
@@ -154,6 +156,7 @@ export default class AlertOwnerTeam extends BaseModel {
title: "Team",
description:
"Team that is the owner. All users in this team will receive notifications. ",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@ManyToOne(
() => {
@@ -191,6 +194,7 @@ export default class AlertOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "Team ID",
description: "ID of your OneUptime Team in which this object belongs",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@Column({
type: ColumnType.ObjectID,
@@ -220,6 +224,7 @@ export default class AlertOwnerTeam extends BaseModel {
modelType: Alert,
title: "Alert",
description: "Relation to Alert Resource in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@ManyToOne(
() => {
@@ -257,6 +262,7 @@ export default class AlertOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "Alert ID",
description: "ID of your OneUptime Alert in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -287,6 +293,7 @@ export default class AlertOwnerTeam 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-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -322,6 +329,7 @@ export default class AlertOwnerTeam extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -347,6 +355,7 @@ export default class AlertOwnerTeam extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@ManyToOne(
() => {
@@ -378,6 +387,7 @@ export default class AlertOwnerTeam 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-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -409,6 +419,7 @@ export default class AlertOwnerTeam extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

11
Common/Models/DatabaseModels/AlertOwnerUser.ts
View File

@@ -86,6 +86,7 @@ export default class AlertOwnerUser extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -123,6 +124,7 @@ export default class AlertOwnerUser 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,
@@ -153,6 +155,7 @@ export default class AlertOwnerUser extends BaseModel {
title: "User",
description:
"User that is the owner. This user will receive notifications. ",
example: "e5f6a7b8-c9d0-1234-efab-345678901234",
})
@ManyToOne(
() => {
@@ -190,6 +193,7 @@ export default class AlertOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "User ID",
description: "ID of your OneUptime User in which this object belongs",
example: "e5f6a7b8-c9d0-1234-efab-345678901234",
})
@Column({
type: ColumnType.ObjectID,
@@ -219,6 +223,7 @@ export default class AlertOwnerUser extends BaseModel {
modelType: Alert,
title: "Alert",
description: "Relation to Alert Resource in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@ManyToOne(
() => {
@@ -256,6 +261,7 @@ export default class AlertOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "Alert ID",
description: "ID of your OneUptime Alert in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -286,6 +292,7 @@ export default class AlertOwnerUser 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-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -321,6 +328,7 @@ export default class AlertOwnerUser extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -346,6 +354,7 @@ export default class AlertOwnerUser extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@ManyToOne(
() => {
@@ -377,6 +386,7 @@ export default class AlertOwnerUser 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-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -408,6 +418,7 @@ export default class AlertOwnerUser extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

15
Common/Models/DatabaseModels/AlertStateTimeline.ts
View File

@@ -91,6 +91,7 @@ export default class AlertStateTimeline extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -128,6 +129,7 @@ export default class AlertStateTimeline 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,
@@ -157,6 +159,7 @@ export default class AlertStateTimeline extends BaseModel {
modelType: Alert,
title: "Alert",
description: "Relation to Alert in which this resource belongs",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@ManyToOne(
() => {
@@ -193,6 +196,7 @@ export default class AlertStateTimeline extends BaseModel {
required: true,
title: "Alert ID",
description: "Relation to Alert ID in which this resource belongs",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@Column({
type: ColumnType.ObjectID,
@@ -223,6 +227,7 @@ export default class AlertStateTimeline extends BaseModel {
title: "Created by User",
description:
"Relation to User who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@ManyToOne(
() => {
@@ -258,6 +263,7 @@ export default class AlertStateTimeline extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -278,6 +284,7 @@ export default class AlertStateTimeline extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -304,6 +311,7 @@ export default class AlertStateTimeline extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -339,6 +347,7 @@ export default class AlertStateTimeline extends BaseModel {
title: "Alert State",
description:
"Alert State Relation. Which alert state does this alert change to?",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@ManyToOne(
() => {
@@ -380,6 +389,7 @@ export default class AlertStateTimeline extends BaseModel {
title: "Alert State ID",
description:
"Alert State ID Relation. Which alert state does this alert change to?",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -408,6 +418,7 @@ export default class AlertStateTimeline extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of state change?",
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -430,6 +441,7 @@ export default class AlertStateTimeline extends BaseModel {
isDefaultValueColumn: false,
required: false,
type: TableColumnType.JSON,
example: { "previousState": "created", "newState": "acknowledged", "reason": "Alert reviewed by on-call engineer" },
})
@Column({
type: ColumnType.JSON,
@@ -460,6 +472,7 @@ export default class AlertStateTimeline extends BaseModel {
isDefaultValueColumn: false,
title: "Root Cause",
description: "What is the root cause of this status change?",
example: "High memory usage detected on production server due to memory leak in application code.",
})
@Column({
type: ColumnType.Markdown,
@@ -487,6 +500,7 @@ export default class AlertStateTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Ends At",
description: "When did this status change end?",
example: "2024-01-15T12:30:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -515,6 +529,7 @@ export default class AlertStateTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Starts At",
description: "When did this status change?",
example: "2024-01-15T10:30:00.000Z",
})
@Column({
type: ColumnType.Date,

11
Common/Models/DatabaseModels/ApiKeyPermission.ts
View File

@@ -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,

51
Common/Models/DatabaseModels/BillingInvoice.ts
View File

@@ -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,

30
Common/Models/DatabaseModels/CallLog.ts
View File

@@ -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,

11
Common/Models/DatabaseModels/Dashboard.ts
View File

@@ -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,

31
Common/Models/DatabaseModels/EmailLog.ts
View File

@@ -77,6 +77,7 @@ export default class EmailLog extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -109,6 +110,7 @@ export default class EmailLog 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,
@@ -134,6 +136,7 @@ export default class EmailLog extends BaseModel {
title: "To Email",
description: "Email address where the mail was sent",
canReadOnRelationQuery: false,
example: "user@example.com",
})
@Column({
nullable: true,
@@ -160,6 +163,7 @@ export default class EmailLog extends BaseModel {
title: "From Email",
description: "Email address where the mail was sent from",
canReadOnRelationQuery: false,
example: "notification@example.com",
})
@Column({
nullable: true,
@@ -185,6 +189,7 @@ export default class EmailLog extends BaseModel {
title: "Email Subject",
description: "Subject of the email sent",
canReadOnRelationQuery: false,
example: "Alert: High CPU Usage Detected on Server",
})
@Column({
nullable: false,
@@ -209,6 +214,7 @@ export default class EmailLog extends BaseModel {
title: "Status Message",
description: "Status Message (if any)",
canReadOnRelationQuery: false,
example: "Email delivered successfully",
})
@Column({
nullable: true,
@@ -233,6 +239,7 @@ export default class EmailLog extends BaseModel {
title: "Status of the SMS",
description: "Status of the SMS sent",
canReadOnRelationQuery: false,
example: "Sent",
})
@Column({
nullable: false,
@@ -258,6 +265,7 @@ export default class EmailLog extends BaseModel {
title: "Project Smtp Config Id",
description:
"Relation to ProjectSmtpConfig resource in which this object belongs",
example: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
})
@ManyToOne(
() => {
@@ -290,6 +298,7 @@ export default class EmailLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Project Smtp Config ID",
description: "ID of your Project Smtp Config in which this object belongs",
example: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
})
@Column({
type: ColumnType.ObjectID,
@@ -316,6 +325,7 @@ export default class EmailLog extends BaseModel {
modelType: Incident,
title: "Incident",
description: "Incident associated with this email (if any)",
example: "b2c3d4e5-6789-01bc-def2-234567890abc",
})
@ManyToOne(
() => {
@@ -348,6 +358,7 @@ export default class EmailLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Incident ID",
description: "ID of Incident associated with this email (if any)",
example: "b2c3d4e5-6789-01bc-def2-234567890abc",
})
@Column({
type: ColumnType.ObjectID,
@@ -372,6 +383,7 @@ export default class EmailLog extends BaseModel {
modelType: User,
title: "User",
description: "User who initiated this email (if any)",
example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
})
@ManyToOne(
() => {
@@ -404,6 +416,7 @@ export default class EmailLog extends BaseModel {
canReadOnRelationQuery: true,
title: "User ID",
description: "ID of User who initiated this email (if any)",
example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
})
@Column({
type: ColumnType.ObjectID,
@@ -428,6 +441,7 @@ export default class EmailLog extends BaseModel {
modelType: Alert,
title: "Alert",
description: "Alert associated with this email (if any)",
example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
})
@ManyToOne(
() => {
@@ -460,6 +474,7 @@ export default class EmailLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Alert ID",
description: "ID of Alert associated with this email (if any)",
example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
})
@Column({
type: ColumnType.ObjectID,
@@ -484,6 +499,7 @@ export default class EmailLog extends BaseModel {
modelType: ScheduledMaintenance,
title: "Scheduled Maintenance",
description: "Scheduled Maintenance associated with this email (if any)",
example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
})
@ManyToOne(
() => {
@@ -517,6 +533,7 @@ export default class EmailLog extends BaseModel {
title: "Scheduled Maintenance ID",
description:
"ID of Scheduled Maintenance associated with this email (if any)",
example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
})
@Column({
type: ColumnType.ObjectID,
@@ -541,6 +558,7 @@ export default class EmailLog extends BaseModel {
modelType: StatusPage,
title: "Status Page",
description: "Status Page associated with this email (if any)",
example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
})
@ManyToOne(
() => {
@@ -573,6 +591,7 @@ export default class EmailLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Status Page ID",
description: "ID of Status Page associated with this email (if any)",
example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
})
@Column({
type: ColumnType.ObjectID,
@@ -597,6 +616,7 @@ export default class EmailLog extends BaseModel {
modelType: StatusPageAnnouncement,
title: "Status Page Announcement",
description: "Status Page Announcement associated with this email (if any)",
example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
})
@ManyToOne(
() => {
@@ -630,6 +650,7 @@ export default class EmailLog extends BaseModel {
title: "Status Page Announcement ID",
description:
"ID of Status Page Announcement associated with this email (if any)",
example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
})
@Column({
type: ColumnType.ObjectID,
@@ -654,6 +675,7 @@ export default class EmailLog extends BaseModel {
modelType: OnCallDutyPolicy,
title: "On-Call Duty Policy",
description: "On-Call Duty Policy associated with this email (if any)",
example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
})
@ManyToOne(
() => {
@@ -687,6 +709,7 @@ export default class EmailLog extends BaseModel {
title: "On-Call Duty Policy ID",
description:
"ID of On-Call Duty Policy associated with this email (if any)",
example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
})
@Column({
type: ColumnType.ObjectID,
@@ -712,6 +735,7 @@ export default class EmailLog extends BaseModel {
title: "On-Call Duty Policy Escalation Rule",
description:
"On-Call Duty Policy Escalation Rule associated with this email (if any)",
example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
})
@ManyToOne(
() => {
@@ -746,6 +770,7 @@ export default class EmailLog extends BaseModel {
title: "On-Call Duty Policy Escalation Rule ID",
description:
"ID of On-Call Duty Policy Escalation Rule associated with this email (if any)",
example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
})
@Column({
type: ColumnType.ObjectID,
@@ -771,6 +796,7 @@ export default class EmailLog extends BaseModel {
title: "On-Call Duty Policy Schedule",
description:
"On-Call Duty Policy Schedule associated with this email (if any)",
example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
})
@ManyToOne(
() => {
@@ -804,6 +830,7 @@ export default class EmailLog extends BaseModel {
title: "On-Call Duty Policy Schedule ID",
description:
"ID of On-Call Duty Policy Schedule associated with this email (if any)",
example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
})
@Column({
type: ColumnType.ObjectID,
@@ -828,6 +855,7 @@ export default class EmailLog extends BaseModel {
modelType: Team,
title: "Team",
description: "Team associated with this email (if any)",
example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
})
@ManyToOne(
() => {
@@ -860,6 +888,7 @@ export default class EmailLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Team ID",
description: "ID of Team associated with this email (if any)",
example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
})
@Column({
type: ColumnType.ObjectID,
@@ -880,6 +909,7 @@ export default class EmailLog 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(
() => {
@@ -906,6 +936,7 @@ export default class EmailLog 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,

6
Common/Models/DatabaseModels/IncidentCustomField.ts
View File

@@ -120,6 +120,7 @@ export default class IncidentCustomField 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,
@@ -152,6 +153,7 @@ export default class IncidentCustomField extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "Severity Level",
})
@Column({
nullable: false,
@@ -185,6 +187,7 @@ export default class IncidentCustomField extends BaseModel {
title: "Description",
description:
"Friendly description of this custom field that will help you remember",
example: "This field tracks the severity level of the incident (Minor, Major, Critical)",
})
@Column({
nullable: true,
@@ -212,6 +215,7 @@ export default class IncidentCustomField extends BaseModel {
type: TableColumnType.CustomFieldType,
title: "Custom Field Type",
description: "Is this field Text, Number or Boolean?",
example: "Text",
})
@Column({
nullable: true,
@@ -275,6 +279,7 @@ export default class IncidentCustomField extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
})
@Column({
type: ColumnType.ObjectID,
@@ -331,6 +336,7 @@ export default class IncidentCustomField extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "b5c4d3e2-f1a0-4b5c-9d8e-7f6a5b4c3d2e",
})
@Column({
type: ColumnType.ObjectID,

15
Common/Models/DatabaseModels/IncidentFeed.ts
View File

@@ -99,6 +99,7 @@ export default class IncidentFeed extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -136,6 +137,7 @@ export default class IncidentFeed 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 IncidentFeed extends BaseModel {
modelType: Incident,
title: "Incident",
description: "Relation to Incident in which this resource belongs",
example: "a1b2c3d4-f5e6-7890-1234-567890abcdef",
})
@ManyToOne(
() => {
@@ -201,6 +204,7 @@ export default class IncidentFeed extends BaseModel {
required: true,
title: "Incident ID",
description: "Relation to Incident ID in which this resource belongs",
example: "a1b2c3d4-f5e6-7890-1234-567890abcdef",
})
@Column({
type: ColumnType.ObjectID,
@@ -231,6 +235,7 @@ export default class IncidentFeed 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(
() => {
@@ -266,6 +271,7 @@ export default class IncidentFeed 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,
@@ -286,6 +292,7 @@ export default class IncidentFeed 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(
() => {
@@ -312,6 +319,7 @@ export default class IncidentFeed 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,
@@ -340,6 +348,7 @@ export default class IncidentFeed extends BaseModel {
required: true,
title: "Log (in Markdown)",
description: "Log of the entire incident state change in Markdown",
example: "**Incident State Changed**: Status changed from `Acknowledged` to `Resolved` by John Doe",
})
@Column({
type: ColumnType.Markdown,
@@ -368,6 +377,7 @@ export default class IncidentFeed extends BaseModel {
required: false,
title: "More Information (in Markdown)",
description: "More information in Markdown",
example: "### Resolution Details\n\nThe issue was resolved by restarting the database service. All systems are now operational.",
})
@Column({
type: ColumnType.Markdown,
@@ -396,6 +406,7 @@ export default class IncidentFeed extends BaseModel {
required: true,
title: "Incident Feed Event",
description: "Incident Feed Event",
example: "IncidentStateChanged",
})
@Column({
type: ColumnType.ShortText,
@@ -424,6 +435,7 @@ export default class IncidentFeed extends BaseModel {
required: true,
title: "Color",
description: "Display color for the incident log",
example: "#e74c3c",
})
@Column({
type: ColumnType.Color,
@@ -456,6 +468,7 @@ export default class IncidentFeed 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(
() => {
@@ -491,6 +504,7 @@ export default class IncidentFeed 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,
@@ -518,6 +532,7 @@ export default class IncidentFeed 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,

9
Common/Models/DatabaseModels/IncidentNoteTemplate.ts
View File

@@ -93,6 +93,7 @@ export default class IncidentNoteTemplate 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 IncidentNoteTemplate 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,
@@ -164,6 +166,7 @@ export default class IncidentNoteTemplate extends BaseModel {
title: "Note",
description:
"Note template for public or private notes. This is in markdown.",
example: "## Root Cause Analysis\n\n**Incident**: {{incident.title}}\n\n**Start Time**: {{incident.startedAt}}\n\n**Root Cause**: The incident was caused by a memory leak in the payment processing service that resulted in service degradation over time.\n\n**Impact**: Approximately 15% of payment transactions were affected during the incident window.\n\n**Resolution**: Restarted the affected service and deployed a hotfix to address the memory leak.\n\n**Preventive Measures**:\n- Added memory monitoring alerts\n- Implemented automated service restarts\n- Scheduled code review for memory management",
})
@Column({
type: ColumnType.Markdown,
@@ -198,6 +201,7 @@ export default class IncidentNoteTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Name of the Incident Template",
example: "Root Cause Analysis Template",
})
@Column({
nullable: false,
@@ -232,6 +236,7 @@ export default class IncidentNoteTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Template Description",
description: "Description of the Incident Template",
example: "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
})
@Column({
nullable: false,
@@ -262,6 +267,7 @@ export default class IncidentNoteTemplate 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(
() => {
@@ -297,6 +303,7 @@ export default class IncidentNoteTemplate 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,
@@ -317,6 +324,7 @@ export default class IncidentNoteTemplate 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(
() => {
@@ -343,6 +351,7 @@ export default class IncidentNoteTemplate 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,

11
Common/Models/DatabaseModels/IncidentOwnerTeam.ts
View File

@@ -87,6 +87,7 @@ export default class IncidentOwnerTeam extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -124,6 +125,7 @@ export default class IncidentOwnerTeam 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,
@@ -154,6 +156,7 @@ export default class IncidentOwnerTeam extends BaseModel {
title: "Team",
description:
"Team that is the owner. All users in this team will receive notifications. ",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@ManyToOne(
() => {
@@ -191,6 +194,7 @@ export default class IncidentOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "Team ID",
description: "ID of your OneUptime Team in which this object belongs",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@Column({
type: ColumnType.ObjectID,
@@ -220,6 +224,7 @@ export default class IncidentOwnerTeam extends BaseModel {
modelType: Incident,
title: "Incident",
description: "Relation to Incident Resource in which this object belongs",
example: "f6a7b8c9-d0e1-2345-fabc-456789012345",
})
@ManyToOne(
() => {
@@ -257,6 +262,7 @@ export default class IncidentOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "Incident ID",
description: "ID of your OneUptime Incident in which this object belongs",
example: "f6a7b8c9-d0e1-2345-fabc-456789012345",
})
@Column({
type: ColumnType.ObjectID,
@@ -287,6 +293,7 @@ export default class IncidentOwnerTeam 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-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -322,6 +329,7 @@ export default class IncidentOwnerTeam extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -347,6 +355,7 @@ export default class IncidentOwnerTeam extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@ManyToOne(
() => {
@@ -378,6 +387,7 @@ export default class IncidentOwnerTeam 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-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -406,6 +416,7 @@ export default class IncidentOwnerTeam extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

11
Common/Models/DatabaseModels/IncidentOwnerUser.ts
View File

@@ -86,6 +86,7 @@ export default class IncidentOwnerUser extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -123,6 +124,7 @@ export default class IncidentOwnerUser 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,
@@ -153,6 +155,7 @@ export default class IncidentOwnerUser extends BaseModel {
title: "User",
description:
"User that is the owner. This user will receive notifications. ",
example: "e5f6a7b8-c9d0-1234-efab-345678901234",
})
@ManyToOne(
() => {
@@ -190,6 +193,7 @@ export default class IncidentOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "User ID",
description: "ID of your OneUptime User in which this object belongs",
example: "e5f6a7b8-c9d0-1234-efab-345678901234",
})
@Column({
type: ColumnType.ObjectID,
@@ -219,6 +223,7 @@ export default class IncidentOwnerUser extends BaseModel {
modelType: Incident,
title: "Incident",
description: "Relation to Incident Resource in which this object belongs",
example: "f6a7b8c9-d0e1-2345-fabc-456789012345",
})
@ManyToOne(
() => {
@@ -256,6 +261,7 @@ export default class IncidentOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "Incident ID",
description: "ID of your OneUptime Incident in which this object belongs",
example: "f6a7b8c9-d0e1-2345-fabc-456789012345",
})
@Column({
type: ColumnType.ObjectID,
@@ -286,6 +292,7 @@ export default class IncidentOwnerUser 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-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -321,6 +328,7 @@ export default class IncidentOwnerUser extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -346,6 +354,7 @@ export default class IncidentOwnerUser extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@ManyToOne(
() => {
@@ -377,6 +386,7 @@ export default class IncidentOwnerUser 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-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -408,6 +418,7 @@ export default class IncidentOwnerUser extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

18
Common/Models/DatabaseModels/IncidentStateTimeline.ts
View File

@@ -94,6 +94,7 @@ export default class IncidentStateTimeline 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 IncidentStateTimeline 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 IncidentStateTimeline extends BaseModel {
modelType: Incident,
title: "Incident",
description: "Relation to Incident in which this resource belongs",
example: "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
})
@ManyToOne(
() => {
@@ -196,6 +199,7 @@ export default class IncidentStateTimeline extends BaseModel {
required: true,
title: "Incident ID",
description: "Relation to Incident ID in which this resource belongs",
example: "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
})
@Column({
type: ColumnType.ObjectID,
@@ -226,6 +230,7 @@ export default class IncidentStateTimeline extends BaseModel {
title: "Created by User",
description:
"Relation to User who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@ManyToOne(
() => {
@@ -261,6 +266,7 @@ export default class IncidentStateTimeline extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -281,6 +287,7 @@ export default class IncidentStateTimeline extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -307,6 +314,7 @@ export default class IncidentStateTimeline extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -342,6 +350,7 @@ export default class IncidentStateTimeline extends BaseModel {
title: "Incident State",
description:
"Incident State Relation. Which incident state does this incident change to?",
example: "f6a7b8c9-d0e1-2345-6789-0abcdef12345",
})
@ManyToOne(
() => {
@@ -383,6 +392,7 @@ export default class IncidentStateTimeline extends BaseModel {
title: "Incident State ID",
description:
"Incident State ID Relation. Which incident state does this incident change to?",
example: "f6a7b8c9-d0e1-2345-6789-0abcdef12345",
})
@Column({
type: ColumnType.ObjectID,
@@ -420,6 +430,7 @@ export default class IncidentStateTimeline extends BaseModel {
description:
"Status of notification sent to subscribers about this incident state change",
defaultValue: StatusPageSubscriberNotificationStatus.Pending,
example: "Sent",
})
@Column({
type: ColumnType.ShortText,
@@ -454,6 +465,7 @@ export default class IncidentStateTimeline extends BaseModel {
description:
"Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons",
required: false,
example: "Successfully sent notifications to 47 subscribers via email and SMS",
})
@Column({
type: ColumnType.VeryLongText,
@@ -482,6 +494,7 @@ export default class IncidentStateTimeline extends BaseModel {
title: "Should subscribers be notified?",
description: "Should subscribers be notified about this state change?",
defaultValue: true,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -509,6 +522,7 @@ export default class IncidentStateTimeline extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of state change?",
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -531,6 +545,7 @@ export default class IncidentStateTimeline extends BaseModel {
isDefaultValueColumn: false,
required: false,
type: TableColumnType.JSON,
example: { "previousState": "investigating", "newState": "resolved", "triggeredBy": "automated-resolution", "duration": 3600 },
})
@Column({
type: ColumnType.JSON,
@@ -560,6 +575,7 @@ export default class IncidentStateTimeline extends BaseModel {
isDefaultValueColumn: false,
title: "Root Cause",
description: "What is the root cause of this status change?",
example: "Database connection pool exhaustion caused by sudden spike in traffic from marketing campaign launch.",
})
@Column({
type: ColumnType.Markdown,
@@ -587,6 +603,7 @@ export default class IncidentStateTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Ends At",
description: "When did this status change end?",
example: "2024-01-15T14:45:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -615,6 +632,7 @@ export default class IncidentStateTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Starts At",
description: "When did this status change?",
example: "2024-01-15T13:15:00.000Z",
})
@Column({
type: ColumnType.Date,

12
Common/Models/DatabaseModels/IncidentTemplate.ts
View File

@@ -149,6 +149,7 @@ export default class IncidentTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Project ID",
description: "ID of your OneUptime Project in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@Column({
type: ColumnType.ObjectID,
@@ -184,6 +185,7 @@ export default class IncidentTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Title",
description: "Title of this incident",
example: "Production Server Outage - Database Connection Issue",
})
@Column({
nullable: false,
@@ -218,6 +220,7 @@ export default class IncidentTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Name of the Incident Template",
example: "Server Outage Template",
})
@Column({
nullable: false,
@@ -252,6 +255,7 @@ export default class IncidentTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Template Description",
description: "Description of the Incident Template",
example: "Use this template when experiencing server outages due to database connectivity issues. Includes automated notifications to on-call engineers and status page updates.",
})
@Column({
nullable: false,
@@ -286,6 +290,7 @@ export default class IncidentTemplate extends BaseModel {
title: "Description",
description:
"Short description of this incident. This is in markdown and will be visible on the status page.",
example: "## Issue Description\n\nWe are currently experiencing connectivity issues with our primary database server. Our engineering team is actively investigating and working to resolve the issue.\n\n**Impact:** Users may experience slow response times or intermittent errors.",
})
@Column({
nullable: true,
@@ -311,6 +316,7 @@ export default class IncidentTemplate extends BaseModel {
computed: true,
title: "Slug",
description: "Friendly globally unique name for your object",
example: "server-outage-template",
})
@Column({
nullable: false,
@@ -377,6 +383,7 @@ export default class IncidentTemplate 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,
@@ -423,6 +430,7 @@ export default class IncidentTemplate 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,
@@ -637,6 +645,7 @@ export default class IncidentTemplate extends BaseModel {
required: false,
title: "Incident Severity ID",
description: "Incident Severity ID",
example: "c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f",
})
@Column({
type: ColumnType.ObjectID,
@@ -708,6 +717,7 @@ export default class IncidentTemplate 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 incident is created.",
example: "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a",
})
@Column({
type: ColumnType.ObjectID,
@@ -779,6 +789,7 @@ export default class IncidentTemplate extends BaseModel {
title: "Initial Incident State ID",
description:
"Relation to Incident State Object ID. Incidents created from this template will start in this state.",
example: "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
})
@Column({
type: ColumnType.ObjectID,
@@ -813,6 +824,7 @@ export default class IncidentTemplate extends BaseModel {
type: TableColumnType.JSON,
title: "Custom Fields",
description: "Custom Fields on this resource.",
example: { "priority": "high", "category": "infrastructure", "escalationLevel": 2 },
})
@Column({
type: ColumnType.JSON,

6
Common/Models/DatabaseModels/IncidentTemplateOwnerTeam.ts
View File

@@ -123,6 +123,7 @@ export default class IncidentTemplateOwnerTeam 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,
@@ -190,6 +191,7 @@ export default class IncidentTemplateOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "Team ID",
description: "ID of your OneUptime Team in which this object belongs",
example: "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b0c",
})
@Column({
type: ColumnType.ObjectID,
@@ -258,6 +260,7 @@ export default class IncidentTemplateOwnerTeam extends BaseModel {
title: "IncidentTemplate ID",
description:
"ID of your OneUptime IncidentTemplate in which this object belongs",
example: "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c1d",
})
@Column({
type: ColumnType.ObjectID,
@@ -323,6 +326,7 @@ export default class IncidentTemplateOwnerTeam 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,
@@ -379,6 +383,7 @@ export default class IncidentTemplateOwnerTeam 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,
@@ -407,6 +412,7 @@ export default class IncidentTemplateOwnerTeam extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

6
Common/Models/DatabaseModels/IncidentTemplateOwnerUser.ts
View File

@@ -125,6 +125,7 @@ export default class IncidentTemplateOwnerUser 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,
@@ -194,6 +195,7 @@ export default class IncidentTemplateOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "User ID",
description: "ID of your OneUptime User in which this object belongs",
example: "b8c9d0e1-f2a3-4b4c-5d6e-7f8a9b0c1d2e",
})
@Column({
type: ColumnType.ObjectID,
@@ -264,6 +266,7 @@ export default class IncidentTemplateOwnerUser extends BaseModel {
title: "IncidentTemplate ID",
description:
"ID of your OneUptime IncidentTemplate in which this object belongs",
example: "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c1d",
})
@Column({
type: ColumnType.ObjectID,
@@ -331,6 +334,7 @@ export default class IncidentTemplateOwnerUser 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,
@@ -389,6 +393,7 @@ export default class IncidentTemplateOwnerUser 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,
@@ -418,6 +423,7 @@ export default class IncidentTemplateOwnerUser extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

6
Common/Models/DatabaseModels/MonitorCustomField.ts
View File

@@ -120,6 +120,7 @@ export default class MonitorCustomField 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,
@@ -152,6 +153,7 @@ export default class MonitorCustomField extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "Check Interval",
})
@Column({
nullable: false,
@@ -185,6 +187,7 @@ export default class MonitorCustomField extends BaseModel {
title: "Description",
description:
"Friendly description of this custom field that will help you remember",
example: "This field specifies how often the monitor should perform health checks (in minutes)",
})
@Column({
nullable: true,
@@ -212,6 +215,7 @@ export default class MonitorCustomField extends BaseModel {
type: TableColumnType.CustomFieldType,
title: "Custom Field Type",
description: "Is this field Text, Number or Boolean?",
example: "Number",
})
@Column({
nullable: true,
@@ -275,6 +279,7 @@ export default class MonitorCustomField extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
})
@Column({
type: ColumnType.ObjectID,
@@ -331,6 +336,7 @@ export default class MonitorCustomField extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "b5c4d3e2-f1a0-4b5c-9d8e-7f6a5b4c3d2e",
})
@Column({
type: ColumnType.ObjectID,

15
Common/Models/DatabaseModels/MonitorFeed.ts
View File

@@ -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,7 @@ 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 +370,7 @@ 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 +399,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 +428,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 +461,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 +497,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 +525,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,

11
Common/Models/DatabaseModels/MonitorGroupOwnerTeam.ts
View File

@@ -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,

11
Common/Models/DatabaseModels/MonitorGroupOwnerUser.ts
View File

@@ -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,

10
Common/Models/DatabaseModels/MonitorGroupResource.ts
View File

@@ -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,

11
Common/Models/DatabaseModels/MonitorOwnerTeam.ts
View File

@@ -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,

11
Common/Models/DatabaseModels/MonitorOwnerUser.ts
View File

@@ -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,

28
Common/Models/DatabaseModels/MonitorProbe.ts
View File

@@ -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,

10
Common/Models/DatabaseModels/MonitorSecret.ts
View File

@@ -100,6 +100,7 @@ export default class MonitorSecret extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -136,6 +137,7 @@ export default class MonitorSecret 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,
@@ -170,6 +172,7 @@ export default class MonitorSecret extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "API_AUTH_TOKEN",
})
@Column({
nullable: false,
@@ -204,6 +207,7 @@ export default class MonitorSecret extends BaseModel {
type: TableColumnType.LongText,
title: "Description",
description: "Friendly description that will help you remember",
example: "API authentication token for third-party service integration",
})
@Column({
nullable: true,
@@ -232,6 +236,7 @@ export default class MonitorSecret extends BaseModel {
title: "Secret Value",
description:
"Secret value that you want to store in this object. This value will be encrypted and only accessible by the probe.",
example: "sk_live_1234567890abcdefghijklmnop",
})
@Column({
nullable: true,
@@ -262,6 +267,7 @@ export default class MonitorSecret extends BaseModel {
modelType: Monitor,
title: "Monitors",
description: "List of monitors that can access this secret",
example: '["5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"]',
})
@ManyToMany(
() => {
@@ -303,6 +309,7 @@ export default class MonitorSecret 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(
() => {
@@ -337,6 +344,7 @@ export default class MonitorSecret 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,
@@ -362,6 +370,7 @@ export default class MonitorSecret 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(
() => {
@@ -393,6 +402,7 @@ export default class MonitorSecret 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,

15
Common/Models/DatabaseModels/MonitorStatusTimeline.ts
View File

@@ -95,6 +95,7 @@ export default class MonitorStatusTimeline extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -132,6 +133,7 @@ export default class MonitorStatusTimeline 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 MonitorStatusTimeline extends BaseModel {
modelType: Monitor,
title: "Monitor",
description: "Relation to Monitor Resource in which this object belongs",
example: "a7b8c9d0-e1f2-3456-789a-bcdef0123456",
})
@ManyToOne(
() => {
@@ -197,6 +200,7 @@ export default class MonitorStatusTimeline extends BaseModel {
required: true,
title: "Monitor ID",
description: "Relation to Monitor ID Resource in which this object belongs",
example: "a7b8c9d0-e1f2-3456-789a-bcdef0123456",
})
@Column({
type: ColumnType.ObjectID,
@@ -227,6 +231,7 @@ export default class MonitorStatusTimeline extends BaseModel {
title: "Created by User",
description:
"Relation to User who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@ManyToOne(
() => {
@@ -262,6 +267,7 @@ export default class MonitorStatusTimeline extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -282,6 +288,7 @@ export default class MonitorStatusTimeline extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -308,6 +315,7 @@ export default class MonitorStatusTimeline extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -343,6 +351,7 @@ export default class MonitorStatusTimeline extends BaseModel {
title: "Monitor Status",
description:
"Relation to Monitor Status Resource in which this object belongs",
example: "b8c9d0e1-f2a3-4567-890a-bcdef0123456",
})
@ManyToOne(
() => {
@@ -384,6 +393,7 @@ export default class MonitorStatusTimeline extends BaseModel {
title: "Monitor Status ID",
description:
"Relation to Monitor Status ID Resource in which this object belongs",
example: "b8c9d0e1-f2a3-4567-890a-bcdef0123456",
})
@Column({
type: ColumnType.ObjectID,
@@ -412,6 +422,7 @@ export default class MonitorStatusTimeline extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of status change?",
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -434,6 +445,7 @@ export default class MonitorStatusTimeline extends BaseModel {
isDefaultValueColumn: false,
required: false,
type: TableColumnType.JSON,
example: { "previousStatus": "operational", "newStatus": "degraded", "responseTime": 2500, "probeLocation": "us-east-1" },
})
@Column({
type: ColumnType.JSON,
@@ -463,6 +475,7 @@ export default class MonitorStatusTimeline extends BaseModel {
isDefaultValueColumn: false,
title: "Root Cause",
description: "What is the root cause of this status change?",
example: "API response time exceeded threshold of 2000ms due to database query optimization needed on user table.",
})
@Column({
type: ColumnType.Markdown,
@@ -490,6 +503,7 @@ export default class MonitorStatusTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Ends At",
description: "When did this status change end?",
example: "2024-01-15T16:20:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -518,6 +532,7 @@ export default class MonitorStatusTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Starts At",
description: "When did this status change?",
example: "2024-01-15T15:45:00.000Z",
})
@Column({
type: ColumnType.Date,

19
Common/Models/DatabaseModels/MonitorTest.ts
View File

@@ -91,6 +91,7 @@ export default class MonitorTest extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -128,6 +129,7 @@ export default class MonitorTest 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 MonitorTest 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(
() => {
@@ -193,6 +196,7 @@ export default class MonitorTest 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,
@@ -213,6 +217,7 @@ export default class MonitorTest 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(
() => {
@@ -239,6 +244,7 @@ export default class MonitorTest 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,
@@ -267,6 +273,7 @@ export default class MonitorTest extends BaseModel {
type: TableColumnType.MonitorType,
title: "Monitor Type",
description: "What is the type of this monitor? Website? API? etc.",
example: "website",
})
@Column({
nullable: false,
@@ -300,6 +307,7 @@ export default class MonitorTest extends BaseModel {
required: false,
title: "Monitor Steps",
description: "What would you like to monitor and what is the criteria?",
example: '{"steps": [{"url": "https://example.com", "method": "GET"}]}',
})
@Column({
type: ColumnType.JSON,
@@ -334,6 +342,7 @@ export default class MonitorTest extends BaseModel {
modelType: Probe,
title: "Probe",
description: "Relation to Probe Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -376,6 +385,7 @@ export default class MonitorTest extends BaseModel {
canReadOnRelationQuery: true,
title: "Probe ID",
description: "ID of your OneUptime Probe in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@Column({
type: ColumnType.ObjectID,
@@ -404,7 +414,10 @@ export default class MonitorTest extends BaseModel {
Permission.EditProjectMonitor,
],
})
@TableColumn({ type: TableColumnType.Date })
@TableColumn({
type: TableColumnType.Date,
example: "2023-01-15T10:30:00Z",
})
@Column({
type: ColumnType.Date,
nullable: true,
@@ -436,6 +449,7 @@ export default class MonitorTest extends BaseModel {
isDefaultValueColumn: false,
required: false,
type: TableColumnType.JSON,
example: '{"responseTime": 250, "statusCode": 200}',
})
@Column({
type: ColumnType.JSON,
@@ -470,6 +484,7 @@ export default class MonitorTest extends BaseModel {
required: true,
type: TableColumnType.Boolean,
defaultValue: true,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -501,6 +516,7 @@ export default class MonitorTest extends BaseModel {
canReadOnRelationQuery: true,
title: "Monitor ID",
description: "ID of the Monitor this test is related to.",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@Column({
type: ColumnType.ObjectID,
@@ -530,6 +546,7 @@ export default class MonitorTest extends BaseModel {
modelType: Monitor,
title: "Monitor",
description: "Relation to Monitor Resource in which this test belongs.",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {

12
Common/Models/DatabaseModels/OnCallDutyPolicyEscalationRule.ts
View File

@@ -80,6 +80,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -117,6 +118,7 @@ export default class OnCallDutyPolicyEscalationRule 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,
@@ -147,6 +149,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
title: "On-Call Policy",
description:
"Relation to On-Call Policy where this escalation rule belongs.",
example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
})
@ManyToOne(
() => {
@@ -185,6 +188,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
title: "On-Call Policy ID",
description:
"ID of your On-Call Policy where this escalation rule belongs.",
example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
})
@Column({
type: ColumnType.ObjectID,
@@ -220,6 +224,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
title: "Name",
description: "Any friendly name of this object",
canReadOnRelationQuery: true,
example: "Escalate to Team Lead",
})
@Column({
nullable: false,
@@ -253,6 +258,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
type: TableColumnType.LongText,
title: "Description",
description: "Friendly description that will help you remember",
example: "If no response after 15 minutes, escalate to the team lead for immediate attention",
})
@Column({
nullable: true,
@@ -283,6 +289,7 @@ export default class OnCallDutyPolicyEscalationRule 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(
() => {
@@ -318,6 +325,7 @@ export default class OnCallDutyPolicyEscalationRule 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,
@@ -338,6 +346,7 @@ export default class OnCallDutyPolicyEscalationRule 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(
() => {
@@ -364,6 +373,7 @@ export default class OnCallDutyPolicyEscalationRule 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,
@@ -400,6 +410,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
description:
"How long should we wait before we execute the next escalation rule?",
canReadOnRelationQuery: true,
example: 15,
})
@Column({
nullable: true,
@@ -432,6 +443,7 @@ export default class OnCallDutyPolicyEscalationRule extends BaseModel {
type: TableColumnType.Number,
title: "Order",
description: "Order of this rule",
example: 1,
})
@Column({
type: ColumnType.Number,

34
Common/Models/DatabaseModels/OnCallDutyPolicyExecutionLog.ts
View File

@@ -90,6 +90,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -127,6 +128,7 @@ export default class OnCallDutyPolicyExecutionLog 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,
@@ -157,6 +159,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "On-Call Policy",
description:
"Relation to On-Call Policy which belongs to this execution log event.",
example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
})
@ManyToOne(
() => {
@@ -195,6 +198,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "On-Call Policy ID",
description:
"ID of your On-Call Policy which belongs to this execution log event.",
example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
})
@Column({
type: ColumnType.ObjectID,
@@ -225,6 +229,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Triggered By Incident",
description:
"Relation to Incident which triggered this on-call duty policy.",
example: "f6a7b8c9-d0e1-2345-f012-456789012345",
})
@ManyToOne(
() => {
@@ -261,6 +266,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
required: false,
description:
"ID of the incident which triggered this on-call escalation policy.",
example: "f6a7b8c9-d0e1-2345-f012-456789012345",
})
@Column({
type: ColumnType.ObjectID,
@@ -290,6 +296,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
modelType: Alert,
title: "Triggered By Alert",
description: "Relation to Alert which triggered this on-call duty policy.",
example: "a7b8c9d0-e1f2-3456-0123-567890123456",
})
@ManyToOne(
() => {
@@ -326,6 +333,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
required: false,
description:
"ID of the incident which triggered this on-call escalation policy.",
example: "a7b8c9d0-e1f2-3456-0123-567890123456",
})
@Column({
type: ColumnType.ObjectID,
@@ -355,6 +363,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Status",
description: "Status of this execution",
canReadOnRelationQuery: false,
example: "Executing",
})
@Column({
nullable: false,
@@ -384,6 +393,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Status Message",
description: "Status message of this execution",
canReadOnRelationQuery: false,
example: "On-call policy execution started. Notifying primary on-call team members.",
})
@Column({
nullable: false,
@@ -413,6 +423,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Notification Event Type",
description: "Type of event that triggered this on-call duty policy.",
canReadOnRelationQuery: false,
example: "IncidentCreated",
})
@Column({
nullable: false,
@@ -443,6 +454,7 @@ export default class OnCallDutyPolicyExecutionLog 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(
() => {
@@ -478,6 +490,7 @@ export default class OnCallDutyPolicyExecutionLog 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,
@@ -503,6 +516,7 @@ export default class OnCallDutyPolicyExecutionLog 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(
() => {
@@ -539,6 +553,7 @@ export default class OnCallDutyPolicyExecutionLog 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,
@@ -569,6 +584,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Acknowledged by User",
description:
"Relation to User who acknowledged this policy execution (if this policy was acknowledged by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -605,6 +621,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who acknowledged this object (if this object was acknowledged by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -629,7 +646,12 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
update: [],
})
@TableColumn({ type: TableColumnType.Date })
@TableColumn({
type: TableColumnType.Date,
title: "Acknowledged At",
description: "When was this policy execution acknowledged?",
example: "2024-01-15T10:45:00.000Z",
})
@Column({
type: ColumnType.Date,
nullable: true,
@@ -653,6 +675,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Acknowledged by Team",
description:
"Relation to Team who acknowledged this policy execution (if this policy was acknowledged by a Team)",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@ManyToOne(
() => {
@@ -689,6 +712,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Acknowledged by Team ID",
description:
"Team ID who acknowledged this object (if this object was acknowledged by a Team)",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -714,6 +738,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Executed Escalation Rule Order",
description: "Which escalation rule was executed?",
canReadOnRelationQuery: true,
example: 2,
})
@Column({
nullable: true,
@@ -738,6 +763,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Last Escalation Rule Executed At",
description: "When was the escalation rule executed?",
canReadOnRelationQuery: true,
example: "2024-01-15T10:30:00.000Z",
})
@Column({
nullable: true,
@@ -766,6 +792,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
modelType: OnCallDutyPolicyEscalationRule,
title: "Last Executed Escalation Rule",
description: "Relation to On-Call Policy Last Executed Escalation Rule.",
example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
})
@ManyToOne(
() => {
@@ -804,6 +831,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Last Executed Escalation Rule ID",
description: "ID of your On-Call Policy Last Executed Escalation Rule.",
example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
})
@Column({
type: ColumnType.ObjectID,
@@ -830,6 +858,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "Execute next escalation rule in minutes",
description:
"How many minutes should we wait before executing the next escalation rule?",
example: 15,
})
@Column({
type: ColumnType.Number,
@@ -856,6 +885,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
title: "On-Call Policy Execution Repeat Count",
description: "How many times did we execute this on-call policy?",
defaultValue: 1,
example: 3,
})
@Column({
type: ColumnType.Number,
@@ -885,6 +915,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
modelType: User,
title: "Triggered by User",
description: "Relation to User who triggered on-clal policy",
example: "f6a7b8c9-d0e1-2345-f012-456789012345",
})
@ManyToOne(
() => {
@@ -919,6 +950,7 @@ export default class OnCallDutyPolicyExecutionLog extends BaseModel {
type: TableColumnType.ObjectID,
title: "Triggered by User ID",
description: "User ID who triggered this on-call policy",
example: "f6a7b8c9-d0e1-2345-f012-456789012345",
})
@Column({
type: ColumnType.ObjectID,

15
Common/Models/DatabaseModels/OnCallDutyPolicyFeed.ts
View File

@@ -97,6 +97,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -134,6 +135,7 @@ export default class OnCallDutyPolicyFeed 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,
@@ -163,6 +165,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
modelType: OnCallDutyPolicy,
title: "OnCallDutyPolicy",
description: "Relation to OnCallDutyPolicy in which this resource belongs",
example: "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
})
@ManyToOne(
() => {
@@ -200,6 +203,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
title: "OnCallDutyPolicy ID",
description:
"Relation to OnCallDutyPolicy ID in which this resource belongs",
example: "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
})
@Column({
type: ColumnType.ObjectID,
@@ -230,6 +234,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
title: "Created by User",
description:
"Relation to User who created this object (if this object was created by a User)",
example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
})
@ManyToOne(
() => {
@@ -265,6 +270,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
})
@Column({
type: ColumnType.ObjectID,
@@ -285,6 +291,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
})
@ManyToOne(
() => {
@@ -311,6 +318,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
})
@Column({
type: ColumnType.ObjectID,
@@ -339,6 +347,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
required: true,
title: "Log (in Markdown)",
description: "Log of the entire onCallDutyPolicy state change in Markdown",
example: "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
})
@Column({
type: ColumnType.Markdown,
@@ -367,6 +376,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
required: false,
title: "More Information (in Markdown)",
description: "More information in Markdown",
example: "### Roster Details\n\n- Shift: Weekend (Sat-Sun)\n- Coverage: 24/7\n- Escalation policy applied",
})
@Column({
type: ColumnType.Markdown,
@@ -395,6 +405,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
required: true,
title: "On Call Duty Policy Feed Event",
description: "On Call Duty Policy Feed Event",
example: "UserAdded",
})
@Column({
type: ColumnType.ShortText,
@@ -424,6 +435,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
required: true,
title: "Color",
description: "Display color for the onCallDutyPolicy log",
example: "#2ecc71",
})
@Column({
type: ColumnType.Color,
@@ -456,6 +468,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
title: "User",
description:
"Relation to User who this feed belongs to (if this feed belongs to a User)",
example: "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
})
@ManyToOne(
() => {
@@ -491,6 +504,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
title: "User ID",
description:
"User who this feed belongs to (if this feed belongs to a User)",
example: "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
})
@Column({
type: ColumnType.ObjectID,
@@ -518,6 +532,7 @@ export default class OnCallDutyPolicyFeed extends BaseModel {
title: "Feed Posted At",
description: "Date and time when the feed was posted",
type: TableColumnType.Date,
example: "2024-01-15T14:45:30.000Z",
})
@Column({
type: ColumnType.Date,

18
Common/Models/DatabaseModels/OnCallDutyPolicySchedule.ts
View File

@@ -107,6 +107,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -144,6 +145,7 @@ export default class OnCallDutyPolicySchedule 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 +181,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
title: "Name",
description: "Any friendly name of this object",
canReadOnRelationQuery: true,
example: "Weekend On-Call Rotation",
})
@Column({
nullable: false,
@@ -214,6 +217,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
title: "Labels",
description:
"Relation to Labels Array where this object is categorized in.",
example: [{ name: "production" }, { name: "critical" }],
})
@ManyToMany(
() => {
@@ -259,6 +263,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
type: TableColumnType.LongText,
title: "Description",
description: "Friendly description that will help you remember",
example: "This schedule handles on-call duties during weekend hours for production incidents",
})
@Column({
nullable: true,
@@ -290,6 +295,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
title: "Slug",
description: "Friendly globally unique name for your object",
computed: true,
example: "weekend-on-call-rotation",
})
@Column({
nullable: false,
@@ -321,6 +327,7 @@ export default class OnCallDutyPolicySchedule 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(
() => {
@@ -356,6 +363,7 @@ export default class OnCallDutyPolicySchedule 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,
@@ -376,6 +384,7 @@ export default class OnCallDutyPolicySchedule 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(
() => {
@@ -402,6 +411,7 @@ export default class OnCallDutyPolicySchedule 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,
@@ -431,6 +441,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
modelType: User,
title: "Current User On Roster",
description: "Relation to User who is currently on roster",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -460,6 +471,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
type: TableColumnType.ObjectID,
title: "Current User ID On Roster",
description: "User ID who is currently on roster",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -489,6 +501,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
modelType: User,
title: "Next User On Roster",
description: "Relation to User who is next on roster",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@ManyToOne(
() => {
@@ -518,6 +531,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
type: TableColumnType.ObjectID,
title: "Next User ID On Roster",
description: "Next ID who is currently on roster",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -541,6 +555,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
title: "Roster Handoff At",
description:
"When does the roster handoff occur for this schedule for the current user?",
example: "2024-01-15T18:00:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -563,6 +578,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
title: "Roster Next Handoff At",
description:
"When does the next roster handoff occur for this schedule for the next user?",
example: "2024-01-22T18:00:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -585,6 +601,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
title: "Roster Next Event Start At",
description:
"When does the next event start for this schedule for the next user?",
example: "2024-01-22T09:00:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -607,6 +624,7 @@ export default class OnCallDutyPolicySchedule extends BaseModel {
title: "Roster Event Start At",
description:
"When does the current event start for this schedule for the current user?",
example: "2024-01-15T09:00:00.000Z",
})
@Column({
type: ColumnType.Date,

15
Common/Models/DatabaseModels/OnCallDutyPolicyTimeLog.ts
View File

@@ -89,6 +89,7 @@ export default class OnCallDutyPolicyTimeLog 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 OnCallDutyPolicyTimeLog 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 OnCallDutyPolicyTimeLog extends BaseModel {
title: "On-Call Policy ID",
description:
"ID of your On-Call Policy where this escalation rule belongs.",
example: "e5f6a7b8-c9d0-1234-ef01-345678901234",
})
@Column({
type: ColumnType.ObjectID,
@@ -185,6 +188,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
title: "On-Call Policy Schedule ID",
description:
"ID of your On-Call Policy Schedule where this escalation rule belongs.",
example: "f6a7b8c9-d0e1-2345-f012-456789012345",
})
@Column({
type: ColumnType.ObjectID,
@@ -215,6 +219,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
title: "On-Call Policy Escalation Rule ID",
description:
"ID of your On-Call Policy Escalation Rule ID where this escalation rule belongs.",
example: "a7b8c9d0-e1f2-3456-0123-567890123456",
})
@Column({
type: ColumnType.ObjectID,
@@ -245,6 +250,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
title: "Team ID",
description:
"ID of your On-Call Policy Team ID where this escalation rule belongs.",
example: "d4e5f6a7-b8c9-0123-def0-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -273,6 +279,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
canReadOnRelationQuery: true,
title: "More Info",
description: "More information about this log record.",
example: "User was on-call during incident INC-1234. Successfully handled 3 alerts during this shift.",
})
@Column({
type: ColumnType.VeryLongText,
@@ -301,6 +308,7 @@ export default class OnCallDutyPolicyTimeLog 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(
() => {
@@ -335,6 +343,7 @@ export default class OnCallDutyPolicyTimeLog 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,
@@ -364,6 +373,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
title: "Override User",
description:
"Relation to User who is being overridden by this object (if this object was created by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -398,6 +408,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
required: true,
title: "User ID",
description: "User ID for which this log belongs",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -411,6 +422,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
type: TableColumnType.Date,
required: true,
description: "When does this start?",
example: "2024-01-15T09:00:00.000Z",
})
@ColumnAccessControl({
create: [
@@ -437,6 +449,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
type: TableColumnType.Date,
required: false,
description: "When does this end?",
example: "2024-01-15T18:00:00.000Z",
})
@ColumnAccessControl({
create: [
@@ -470,6 +483,7 @@ export default class OnCallDutyPolicyTimeLog 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(
() => {
@@ -496,6 +510,7 @@ export default class OnCallDutyPolicyTimeLog 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,

11
Common/Models/DatabaseModels/ProbeOwnerTeam.ts
View File

@@ -94,6 +94,7 @@ export default class ProbeOwnerTeam 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 ProbeOwnerTeam 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 ProbeOwnerTeam 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 ProbeOwnerTeam 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,
@@ -227,6 +231,7 @@ export default class ProbeOwnerTeam extends BaseModel {
modelType: Probe,
title: "Probe",
description: "Relation to Probe Resource in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
})
@ManyToOne(
() => {
@@ -264,6 +269,7 @@ export default class ProbeOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "Probe ID",
description: "ID of your OneUptime Probe in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -294,6 +300,7 @@ export default class ProbeOwnerTeam 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(
() => {
@@ -329,6 +336,7 @@ export default class ProbeOwnerTeam 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,
@@ -354,6 +362,7 @@ export default class ProbeOwnerTeam 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(
() => {
@@ -385,6 +394,7 @@ export default class ProbeOwnerTeam 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,
@@ -413,6 +423,7 @@ export default class ProbeOwnerTeam extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

11
Common/Models/DatabaseModels/ProbeOwnerUser.ts
View File

@@ -93,6 +93,7 @@ export default class ProbeOwnerUser 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 ProbeOwnerUser 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 ProbeOwnerUser 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 ProbeOwnerUser 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,
@@ -226,6 +230,7 @@ export default class ProbeOwnerUser extends BaseModel {
modelType: Probe,
title: "Probe",
description: "Relation to Probe Resource in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
})
@ManyToOne(
() => {
@@ -263,6 +268,7 @@ export default class ProbeOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "Probe ID",
description: "ID of your OneUptime Probe in which this object belongs",
example: "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -293,6 +299,7 @@ export default class ProbeOwnerUser 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(
() => {
@@ -328,6 +335,7 @@ export default class ProbeOwnerUser 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,
@@ -353,6 +361,7 @@ export default class ProbeOwnerUser 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(
() => {
@@ -384,6 +393,7 @@ export default class ProbeOwnerUser 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,
@@ -412,6 +422,7 @@ export default class ProbeOwnerUser extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

13
Common/Models/DatabaseModels/ProjectCallSMSConfig.ts
View File

@@ -84,6 +84,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -120,6 +121,7 @@ export default class ProjectCallSMSConfig 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,
@@ -150,6 +152,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
required: true,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "Production Twilio Config",
})
@Column({
nullable: false,
@@ -175,6 +178,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
type: TableColumnType.Slug,
title: "Slug",
description: "Friendly globally unique name for your object",
example: "production-twilio-config",
})
@Column({
nullable: false,
@@ -206,6 +210,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
type: TableColumnType.LongText,
title: "Description",
description: "Friendly description that will help you remember",
example: "Twilio configuration for production SMS and call notifications",
})
@Column({
nullable: true,
@@ -235,6 +240,7 @@ export default class ProjectCallSMSConfig 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(
() => {
@@ -269,6 +275,7 @@ export default class ProjectCallSMSConfig 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,
@@ -294,6 +301,7 @@ export default class ProjectCallSMSConfig 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(
() => {
@@ -325,6 +333,7 @@ export default class ProjectCallSMSConfig 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,
@@ -357,6 +366,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
type: TableColumnType.ShortText,
title: "Twilio Account SID",
description: "Account SID for your Twilio Account",
example: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
})
@Column({
type: ColumnType.ShortText,
@@ -388,6 +398,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
type: TableColumnType.ShortText,
title: "Twilio Auth Token",
description: "Auth Token for your Twilio Account",
example: "your-twilio-auth-token",
})
@Column({
type: ColumnType.ShortText,
@@ -419,6 +430,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
type: TableColumnType.Phone,
title: "Twilio Primary Phone Number",
description: "Primary Phone Number for your Twilio account",
example: "+15551234567",
})
@Column({
type: ColumnType.Phone,
@@ -451,6 +463,7 @@ export default class ProjectCallSMSConfig extends BaseModel {
type: TableColumnType.LongText,
title: "Twilio Secondary Phone Numbers",
description: "Secondary Phone Number for your Twilio account",
example: "+15551234568,+15551234569",
})
@Column({
type: ColumnType.LongText,

46
Common/Models/DatabaseModels/ProjectSmtpConfig.ts
View File

@@ -86,6 +86,7 @@ export default class ProjectSmtpConfig extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -122,6 +123,7 @@ export default class ProjectSmtpConfig 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,
@@ -152,6 +154,7 @@ export default class ProjectSmtpConfig extends BaseModel {
required: true,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "Production SMTP Config",
})
@Column({
nullable: false,
@@ -178,6 +181,7 @@ export default class ProjectSmtpConfig extends BaseModel {
title: "Slug",
description: "Friendly globally unique name for your object",
computed: true,
example: "production-smtp-config",
})
@Column({
nullable: false,
@@ -209,6 +213,7 @@ export default class ProjectSmtpConfig extends BaseModel {
type: TableColumnType.LongText,
title: "Description",
description: "Friendly description that will help you remember",
example: "SMTP configuration for production environment email notifications",
})
@Column({
nullable: true,
@@ -238,6 +243,7 @@ export default class ProjectSmtpConfig 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(
() => {
@@ -272,6 +278,7 @@ export default class ProjectSmtpConfig 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,
@@ -297,6 +304,7 @@ export default class ProjectSmtpConfig 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(
() => {
@@ -328,6 +336,7 @@ export default class ProjectSmtpConfig 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,
@@ -358,7 +367,11 @@ export default class ProjectSmtpConfig extends BaseModel {
Permission.EditProjectSMTPConfig,
],
})
@TableColumn({ required: false, type: TableColumnType.ShortText })
@TableColumn({
required: false,
type: TableColumnType.ShortText,
example: "smtp-user@example.com",
})
@Column({
nullable: true,
type: ColumnType.ShortText,
@@ -383,7 +396,11 @@ export default class ProjectSmtpConfig extends BaseModel {
Permission.EditProjectSMTPConfig,
],
})
@TableColumn({ required: false, type: TableColumnType.Password })
@TableColumn({
required: false,
type: TableColumnType.Password,
example: "your-secure-password",
})
@Column({
nullable: true,
type: ColumnType.Password,
@@ -409,7 +426,11 @@ export default class ProjectSmtpConfig extends BaseModel {
Permission.EditProjectSMTPConfig,
],
})
@TableColumn({ required: true, type: TableColumnType.ShortText })
@TableColumn({
required: true,
type: TableColumnType.ShortText,
example: "smtp.gmail.com",
})
@Column({
nullable: false,
type: ColumnType.ShortText,
@@ -436,7 +457,11 @@ export default class ProjectSmtpConfig extends BaseModel {
Permission.EditProjectSMTPConfig,
],
})
@TableColumn({ required: true, type: TableColumnType.Number })
@TableColumn({
required: true,
type: TableColumnType.Number,
example: 587,
})
@Column({
nullable: false,
type: ColumnType.Number,
@@ -462,7 +487,11 @@ export default class ProjectSmtpConfig extends BaseModel {
Permission.EditProjectSMTPConfig,
],
})
@TableColumn({ required: true, type: TableColumnType.Email })
@TableColumn({
required: true,
type: TableColumnType.Email,
example: "noreply@example.com",
})
@Column({
nullable: false,
type: ColumnType.Email,
@@ -489,7 +518,11 @@ export default class ProjectSmtpConfig extends BaseModel {
Permission.EditProjectSMTPConfig,
],
})
@TableColumn({ required: true, type: TableColumnType.ShortText })
@TableColumn({
required: true,
type: TableColumnType.ShortText,
example: "OneUptime Notifications",
})
@Column({
nullable: false,
type: ColumnType.ShortText,
@@ -519,6 +552,7 @@ export default class ProjectSmtpConfig extends BaseModel {
required: true,
type: TableColumnType.Boolean,
defaultValue: true,
example: true,
})
@Column({
nullable: false,

16
Common/Models/DatabaseModels/ProjectSso.ts
View File

@@ -97,6 +97,7 @@ export default class ProjectSSO 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 ProjectSSO 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,
@@ -175,6 +177,7 @@ export default class ProjectSSO extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "Okta SSO Integration",
})
@Column({
nullable: false,
@@ -209,6 +212,7 @@ export default class ProjectSSO extends BaseModel {
required: true,
type: TableColumnType.LongText,
canReadOnRelationQuery: true,
example: "Single Sign-On integration with company Okta identity provider",
})
@Column({
nullable: false,
@@ -237,6 +241,7 @@ export default class ProjectSSO extends BaseModel {
required: true,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "sha256",
})
@Column({
nullable: false,
@@ -266,6 +271,7 @@ export default class ProjectSSO extends BaseModel {
required: true,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "sha256",
})
@Column({
nullable: false,
@@ -299,6 +305,7 @@ export default class ProjectSSO extends BaseModel {
required: true,
type: TableColumnType.LongURL,
canReadOnRelationQuery: true,
example: "https://sso.example.com/saml/login",
})
@Column({
nullable: false,
@@ -330,6 +337,7 @@ export default class ProjectSSO extends BaseModel {
required: false,
type: TableColumnType.EntityArray,
modelType: Team,
example: [{ id: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e" }],
})
@ManyToMany(
() => {
@@ -372,6 +380,7 @@ export default class ProjectSSO extends BaseModel {
required: true,
type: TableColumnType.LongURL,
canReadOnRelationQuery: true,
example: "https://sso.example.com",
})
@Column({
nullable: false,
@@ -401,6 +410,7 @@ export default class ProjectSSO extends BaseModel {
required: true,
type: TableColumnType.VeryLongText,
canReadOnRelationQuery: true,
example: "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAKL0UG...\n-----END CERTIFICATE-----",
})
@Column({
nullable: false,
@@ -430,6 +440,7 @@ export default class ProjectSSO 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(
() => {
@@ -465,6 +476,7 @@ export default class ProjectSSO 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,
@@ -491,6 +503,7 @@ export default class ProjectSSO 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(
() => {
@@ -523,6 +536,7 @@ export default class ProjectSSO 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,
@@ -555,6 +569,7 @@ export default class ProjectSSO extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -582,6 +597,7 @@ export default class ProjectSSO extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,

21
Common/Models/DatabaseModels/PromoCode.ts
View File

@@ -48,6 +48,7 @@ export default class PromoCode extends BaseModel {
canReadOnRelationQuery: true,
title: "Resller ID",
description: "ID that is shared between resller and OneUptime.",
example: "SUMMER2024",
})
@Column({
nullable: false,
@@ -68,6 +69,7 @@ export default class PromoCode extends BaseModel {
title: "Plan Type",
description:
"If this promocode can be used for specific plan, please specify here. If null, it can be used for all the plans",
example: "Growth",
})
@Column({
nullable: true,
@@ -88,6 +90,7 @@ export default class PromoCode extends BaseModel {
title: "User Email",
description:
"Which user can redeem this promocode? If no one is specified, anyone can redeem this promocode.",
example: "user@example.com",
})
@Column({
nullable: true,
@@ -118,6 +121,7 @@ export default class PromoCode 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(
() => {
@@ -152,6 +156,7 @@ export default class PromoCode 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,
@@ -177,6 +182,7 @@ export default class PromoCode 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(
() => {
@@ -208,6 +214,7 @@ export default class PromoCode 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,
@@ -227,6 +234,7 @@ export default class PromoCode extends BaseModel {
modelType: Reseller,
title: "Reseller",
description: "Relation to Reseller Resource in which this object belongs",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -254,6 +262,7 @@ export default class PromoCode extends BaseModel {
canReadOnRelationQuery: true,
title: "Reseller ID",
description: "ID of your OneUptime Reseller in which this object belongs",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -274,6 +283,7 @@ export default class PromoCode extends BaseModel {
title: "ResellerPlan",
description:
"Relation to ResellerPlan Resource in which this object belongs",
example: "d4e5f6a7-b8c9-0123-def1-234567890123",
})
@ManyToOne(
() => {
@@ -302,6 +312,7 @@ export default class PromoCode extends BaseModel {
title: "Reseller Plan ID",
description:
"ID of your OneUptime Reseller Plan in which this object belongs",
example: "d4e5f6a7-b8c9-0123-def1-234567890123",
})
@Column({
type: ColumnType.ObjectID,
@@ -332,6 +343,7 @@ export default class PromoCode extends BaseModel {
title: "License ID",
description: "License ID from a OneUptime Reseller",
canReadOnRelationQuery: true,
example: "LIC-2024-ABCD1234",
})
@Column({
nullable: true,
@@ -349,6 +361,7 @@ export default class PromoCode extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,
@@ -361,7 +374,11 @@ export default class PromoCode extends BaseModel {
read: [],
update: [],
})
@TableColumn({ isDefaultValueColumn: false, type: TableColumnType.Date })
@TableColumn({
isDefaultValueColumn: false,
type: TableColumnType.Date,
example: "2024-06-15T10:30:00.000Z",
})
@Column({
type: ColumnType.Date,
nullable: true,
@@ -380,6 +397,7 @@ export default class PromoCode extends BaseModel {
title: "Project",
description:
"If promo code is used for a specific project, please specify here.",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -408,6 +426,7 @@ export default class PromoCode extends BaseModel {
title: "Project ID",
description:
"If promo code is used for a specific project, please specify here.",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@Column({
type: ColumnType.ObjectID,

30
Common/Models/DatabaseModels/PushNotificationLog.ts
View File

@@ -75,6 +75,7 @@ export default class PushNotificationLog 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 PushNotificationLog 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,
@@ -131,6 +133,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Title",
description: "Title of the push notification",
canReadOnRelationQuery: false,
example: "Alert: High CPU Usage Detected",
})
@Column({
nullable: false,
@@ -155,6 +158,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Body",
description: "Body of the push notification",
canReadOnRelationQuery: false,
example: "Your server 'web-server-01' has exceeded 90% CPU usage for the past 5 minutes.",
})
@Column({
nullable: true,
@@ -178,6 +182,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Device Type",
description: "Type of device this was sent to (e.g., web)",
canReadOnRelationQuery: false,
example: "web",
})
@Column({
nullable: true,
@@ -202,6 +207,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Device Name",
description: "Name of the device this was sent to",
canReadOnRelationQuery: false,
example: "Chrome on MacOS",
})
@Column({
nullable: true,
@@ -226,6 +232,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Status Message",
description: "Status Message (if any)",
canReadOnRelationQuery: false,
example: "Notification sent successfully",
})
@Column({
nullable: true,
@@ -250,6 +257,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Status",
description: "Status of the push notification",
canReadOnRelationQuery: false,
example: "Sent",
})
@Column({
nullable: false,
@@ -276,6 +284,7 @@ export default class PushNotificationLog extends BaseModel {
modelType: Incident,
title: "Incident",
description: "Incident associated with this Push (if any)",
example: "b2c3d4e5-6789-01bc-def2-234567890abc",
})
@ManyToOne(
() => {
@@ -308,6 +317,7 @@ export default class PushNotificationLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Incident ID",
description: "ID of Incident associated with this Push (if any)",
example: "b2c3d4e5-6789-01bc-def2-234567890abc",
})
@Column({
type: ColumnType.ObjectID,
@@ -332,6 +342,7 @@ export default class PushNotificationLog extends BaseModel {
modelType: User,
title: "User",
description: "User who initiated this Push notification (if any)",
example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
})
@ManyToOne(
() => {
@@ -364,6 +375,7 @@ export default class PushNotificationLog extends BaseModel {
canReadOnRelationQuery: true,
title: "User ID",
description: "ID of User who initiated this Push notification (if any)",
example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
})
@Column({
type: ColumnType.ObjectID,
@@ -388,6 +400,7 @@ export default class PushNotificationLog extends BaseModel {
modelType: Alert,
title: "Alert",
description: "Alert associated with this Push (if any)",
example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
})
@ManyToOne(
() => {
@@ -420,6 +433,7 @@ export default class PushNotificationLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Alert ID",
description: "ID of Alert associated with this Push (if any)",
example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
})
@Column({
type: ColumnType.ObjectID,
@@ -444,6 +458,7 @@ export default class PushNotificationLog extends BaseModel {
modelType: ScheduledMaintenance,
title: "Scheduled Maintenance",
description: "Scheduled Maintenance associated with this Push (if any)",
example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
})
@ManyToOne(
() => {
@@ -477,6 +492,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Scheduled Maintenance ID",
description:
"ID of Scheduled Maintenance associated with this Push (if any)",
example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
})
@Column({
type: ColumnType.ObjectID,
@@ -501,6 +517,7 @@ export default class PushNotificationLog extends BaseModel {
modelType: StatusPage,
title: "Status Page",
description: "Status Page associated with this Push (if any)",
example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
})
@ManyToOne(
() => {
@@ -533,6 +550,7 @@ export default class PushNotificationLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Status Page ID",
description: "ID of Status Page associated with this Push (if any)",
example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
})
@Column({
type: ColumnType.ObjectID,
@@ -557,6 +575,7 @@ export default class PushNotificationLog extends BaseModel {
modelType: StatusPageAnnouncement,
title: "Status Page Announcement",
description: "Status Page Announcement associated with this Push (if any)",
example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
})
@ManyToOne(
() => {
@@ -590,6 +609,7 @@ export default class PushNotificationLog extends BaseModel {
title: "Status Page Announcement ID",
description:
"ID of Status Page Announcement associated with this Push (if any)",
example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
})
@Column({
type: ColumnType.ObjectID,
@@ -615,6 +635,7 @@ export default class PushNotificationLog extends BaseModel {
title: "On-Call Duty Policy",
description:
"On-Call Duty Policy associated with this Push Notification (if any)",
example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
})
@ManyToOne(
() => {
@@ -648,6 +669,7 @@ export default class PushNotificationLog extends BaseModel {
title: "On-Call Duty Policy ID",
description:
"ID of On-Call Duty Policy associated with this Push Notification (if any)",
example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
})
@Column({
type: ColumnType.ObjectID,
@@ -673,6 +695,7 @@ export default class PushNotificationLog extends BaseModel {
title: "On-Call Duty Policy Escalation Rule",
description:
"On-Call Duty Policy Escalation Rule associated with this Push Notification (if any)",
example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
})
@ManyToOne(
() => {
@@ -707,6 +730,7 @@ export default class PushNotificationLog extends BaseModel {
title: "On-Call Duty Policy Escalation Rule ID",
description:
"ID of On-Call Duty Policy Escalation Rule associated with this Push Notification (if any)",
example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
})
@Column({
type: ColumnType.ObjectID,
@@ -732,6 +756,7 @@ export default class PushNotificationLog extends BaseModel {
title: "On-Call Duty Policy Schedule",
description:
"On-Call Duty Policy Schedule associated with this Push Notification (if any)",
example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
})
@ManyToOne(
() => {
@@ -765,6 +790,7 @@ export default class PushNotificationLog extends BaseModel {
title: "On-Call Duty Policy Schedule ID",
description:
"ID of On-Call Duty Policy Schedule associated with this Push Notification (if any)",
example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
})
@Column({
type: ColumnType.ObjectID,
@@ -789,6 +815,7 @@ export default class PushNotificationLog extends BaseModel {
modelType: Team,
title: "Team",
description: "Team associated with this Push Notification (if any)",
example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
})
@ManyToOne(
() => {
@@ -821,6 +848,7 @@ export default class PushNotificationLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Team ID",
description: "ID of Team associated with this Push Notification (if any)",
example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
})
@Column({
type: ColumnType.ObjectID,
@@ -841,6 +869,7 @@ export default class PushNotificationLog 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(
() => {
@@ -867,6 +896,7 @@ export default class PushNotificationLog 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,

12
Common/Models/DatabaseModels/Reseller.ts
View File

@@ -44,6 +44,7 @@ export default class Reseller extends BaseModel {
canReadOnRelationQuery: true,
title: "Resller ID",
description: "ID that is shared between resller and OneUptime.",
example: "reseller_1234567890",
})
@Column({
nullable: false,
@@ -63,6 +64,7 @@ export default class Reseller extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Name of the reseller",
example: "Enterprise Solutions Inc.",
})
@Column({
nullable: false,
@@ -82,6 +84,7 @@ export default class Reseller extends BaseModel {
canReadOnRelationQuery: true,
title: "Description",
description: "Description of the reseller",
example: "Leading provider of monitoring solutions for enterprises",
})
@Column({
nullable: false,
@@ -101,6 +104,7 @@ export default class Reseller extends BaseModel {
canReadOnRelationQuery: false,
title: "Username",
description: "Username of the reseller",
example: "enterprise_admin",
})
@Column({
nullable: false,
@@ -120,6 +124,7 @@ export default class Reseller extends BaseModel {
canReadOnRelationQuery: false,
title: "Password",
description: "Password for reseller to login",
example: "$2b$10$abcdefghijklmnopqrstuvwxyz1234567890",
})
@Column({
nullable: false,
@@ -140,6 +145,7 @@ export default class Reseller 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(
() => {
@@ -165,6 +171,7 @@ export default class Reseller 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,
@@ -185,6 +192,7 @@ export default class Reseller 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(
() => {
@@ -211,6 +219,7 @@ export default class Reseller 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,
@@ -230,6 +239,7 @@ export default class Reseller extends BaseModel {
canReadOnRelationQuery: true,
title: "Change Plan Link",
description: "Reseller Change plan Link",
example: "https://reseller.oneuptime.com/change-plan",
})
@Column({
nullable: true,
@@ -251,6 +261,7 @@ export default class Reseller extends BaseModel {
title: "Hide Phone Number on Signup",
description:
"Should we hide the phone number on sign up form based on reseller request?",
example: true,
})
@Column({
nullable: true,
@@ -270,6 +281,7 @@ export default class Reseller extends BaseModel {
title: "Enable Telemetry Features",
description: "Should we enable telemetry features for this reseller?",
defaultValue: false,
example: false,
})
@Column({
nullable: true,

13
Common/Models/DatabaseModels/ResellerPlan.ts
View File

@@ -46,6 +46,7 @@ export default class ResellerPlan extends BaseModel {
modelType: Reseller,
title: "Reseller",
description: "Relation to Reseller Resource in which this object belongs",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -73,6 +74,7 @@ export default class ResellerPlan extends BaseModel {
canReadOnRelationQuery: true,
title: "Reseller ID",
description: "ID of your OneUptime Reseller in which this object belongs",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -93,6 +95,7 @@ export default class ResellerPlan extends BaseModel {
title: "Plan ID",
description:
"ID of the plan. This is shared by the Reseller and OneUptime.",
example: "plan_enterprise_2024",
})
@Column({
nullable: false,
@@ -112,6 +115,7 @@ export default class ResellerPlan extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Name of the Reseller Plan",
example: "Enterprise Plan",
})
@Column({
nullable: false,
@@ -131,6 +135,7 @@ export default class ResellerPlan extends BaseModel {
canReadOnRelationQuery: true,
title: "Plan Type",
description: "Name of the Base Plan that the project should created with.",
example: "Growth",
})
@Column({
nullable: false,
@@ -150,6 +155,7 @@ export default class ResellerPlan extends BaseModel {
canReadOnRelationQuery: true,
title: "Description",
description: "Description of the Reseller Plan",
example: "Comprehensive monitoring solution for large organizations",
})
@Column({
nullable: false,
@@ -169,6 +175,7 @@ export default class ResellerPlan extends BaseModel {
canReadOnRelationQuery: true,
title: "Monitor Limit",
description: "Monitor Limit of the OneUptime Project.",
example: 100,
})
@Column({
nullable: true,
@@ -187,6 +194,7 @@ export default class ResellerPlan extends BaseModel {
canReadOnRelationQuery: true,
title: "Team Member Limit",
description: "Team Member Limit of the OneUptime Project.",
example: 25,
})
@Column({
nullable: true,
@@ -206,6 +214,7 @@ export default class ResellerPlan 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(
() => {
@@ -231,6 +240,7 @@ export default class ResellerPlan 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,
@@ -251,6 +261,7 @@ export default class ResellerPlan 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(
() => {
@@ -277,6 +288,7 @@ export default class ResellerPlan 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,
@@ -297,6 +309,7 @@ export default class ResellerPlan extends BaseModel {
title: "Other Features",
description:
"Other Features of this Reseller Plan. This is shown on the dashboard. Its a comma separated list of features",
example: "Advanced Analytics, Custom Integrations, Priority Support",
})
@Column({
nullable: true,

6
Common/Models/DatabaseModels/ScheduledMaintenanceCustomField.ts
View File

@@ -120,6 +120,7 @@ export default class ScheduledMaintenanceCustomField 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,
@@ -152,6 +153,7 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "Maintenance Window",
})
@Column({
nullable: false,
@@ -185,6 +187,7 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
title: "Description",
description:
"Friendly description of this custom field that will help you remember",
example: "This field indicates the maintenance window type (Planned, Emergency, Routine)",
})
@Column({
nullable: true,
@@ -212,6 +215,7 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
type: TableColumnType.CustomFieldType,
title: "Custom Field Type",
description: "Is this field Text, Number or Boolean?",
example: "Text",
})
@Column({
nullable: true,
@@ -275,6 +279,7 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
})
@Column({
type: ColumnType.ObjectID,
@@ -331,6 +336,7 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "b5c4d3e2-f1a0-4b5c-9d8e-7f6a5b4c3d2e",
})
@Column({
type: ColumnType.ObjectID,

15
Common/Models/DatabaseModels/ScheduledMaintenanceFeed.ts
View File

@@ -99,6 +99,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -136,6 +137,7 @@ export default class ScheduledMaintenanceFeed 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,
@@ -166,6 +168,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "ScheduledMaintenance",
description:
"Relation to ScheduledMaintenance in which this resource belongs",
example: "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f",
})
@ManyToOne(
() => {
@@ -203,6 +206,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "ScheduledMaintenance ID",
description:
"Relation to ScheduledMaintenance ID in which this resource belongs",
example: "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f",
})
@Column({
type: ColumnType.ObjectID,
@@ -233,6 +237,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "Created by User",
description:
"Relation to User who created this object (if this object was created by a User)",
example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
})
@ManyToOne(
() => {
@@ -268,6 +273,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
})
@Column({
type: ColumnType.ObjectID,
@@ -288,6 +294,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
})
@ManyToOne(
() => {
@@ -314,6 +321,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
})
@Column({
type: ColumnType.ObjectID,
@@ -343,6 +351,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "Log (in Markdown)",
description:
"Log of the entire scheduled maintenance state change in Markdown",
example: "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
})
@Column({
type: ColumnType.Markdown,
@@ -371,6 +380,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
required: false,
title: "More Information (in Markdown)",
description: "More information in Markdown",
example: "### Additional Details\n\n- All services will be temporarily unavailable\n- Email notifications sent to all subscribers\n- Backup completed successfully",
})
@Column({
type: ColumnType.Markdown,
@@ -399,6 +409,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
required: true,
title: "ScheduledMaintenance Log Event",
description: "ScheduledMaintenance Log Event",
example: "ScheduledMaintenanceCreated",
})
@Column({
type: ColumnType.ShortText,
@@ -429,6 +440,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
required: true,
title: "Color",
description: "Display color for this log",
example: "#3498db",
})
@Column({
type: ColumnType.Color,
@@ -461,6 +473,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "User",
description:
"Relation to User who this feed belongs to (if this feed belongs to a User)",
example: "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
})
@ManyToOne(
() => {
@@ -496,6 +509,7 @@ export default class ScheduledMaintenanceFeed extends BaseModel {
title: "User ID",
description:
"User who this feed belongs to (if this feed belongs to a User)",
example: "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
})
@Column({
type: ColumnType.ObjectID,
@@ -523,6 +537,7 @@ export default class ScheduledMaintenanceFeed 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,

9
Common/Models/DatabaseModels/ScheduledMaintenanceNoteTemplate.ts
View File

@@ -86,6 +86,7 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -123,6 +124,7 @@ export default class ScheduledMaintenanceNoteTemplate 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,
@@ -157,6 +159,7 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
title: "Note",
description:
"Note template for public or private notes. This is in markdown.",
example: "## Scheduled Maintenance Update\n\n**Maintenance Window**: {{maintenance.scheduledAt}} - {{maintenance.endTime}}\n\n**Affected Services**: {{maintenance.services}}\n\n**Status**: The scheduled maintenance has been completed successfully. All systems are now operational.\n\n**Summary of Work Performed**:\n- Database schema upgrades applied\n- Security patches installed\n- Performance optimizations implemented\n\n**Verification**: All post-maintenance tests have passed. Services are running normally.\n\n**Next Scheduled Maintenance**: TBD",
})
@Column({
type: ColumnType.Markdown,
@@ -191,6 +194,7 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Name of the Incident Template",
example: "Maintenance Completion Summary",
})
@Column({
nullable: false,
@@ -225,6 +229,7 @@ export default class ScheduledMaintenanceNoteTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Template Description",
description: "Description of the Incident Template",
example: "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
})
@Column({
nullable: false,
@@ -255,6 +260,7 @@ export default class ScheduledMaintenanceNoteTemplate 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(
() => {
@@ -290,6 +296,7 @@ export default class ScheduledMaintenanceNoteTemplate 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,
@@ -310,6 +317,7 @@ export default class ScheduledMaintenanceNoteTemplate 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(
() => {
@@ -336,6 +344,7 @@ export default class ScheduledMaintenanceNoteTemplate 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,

11
Common/Models/DatabaseModels/ScheduledMaintenanceOwnerTeam.ts
View File

@@ -87,6 +87,7 @@ export default class ScheduledMaintenanceOwnerTeam 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(
() => {
@@ -124,6 +125,7 @@ export default class ScheduledMaintenanceOwnerTeam 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,
@@ -154,6 +156,7 @@ export default class ScheduledMaintenanceOwnerTeam 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(
() => {
@@ -191,6 +194,7 @@ export default class ScheduledMaintenanceOwnerTeam 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,
@@ -221,6 +225,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
title: "ScheduledMaintenance",
description:
"Relation to ScheduledMaintenance Resource in which this object belongs",
example: "scheduled-maintenance-id-4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
})
@ManyToOne(
() => {
@@ -259,6 +264,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
title: "ScheduledMaintenance ID",
description:
"ID of your OneUptime ScheduledMaintenance in which this object belongs",
example: "4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
})
@Column({
type: ColumnType.ObjectID,
@@ -289,6 +295,7 @@ export default class ScheduledMaintenanceOwnerTeam 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(
() => {
@@ -324,6 +331,7 @@ export default class ScheduledMaintenanceOwnerTeam 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,
@@ -349,6 +357,7 @@ export default class ScheduledMaintenanceOwnerTeam 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(
() => {
@@ -380,6 +389,7 @@ export default class ScheduledMaintenanceOwnerTeam 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,
@@ -408,6 +418,7 @@ export default class ScheduledMaintenanceOwnerTeam extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,

11
Common/Models/DatabaseModels/ScheduledMaintenanceOwnerUser.ts
View File

@@ -86,6 +86,7 @@ export default class ScheduledMaintenanceOwnerUser 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(
() => {
@@ -123,6 +124,7 @@ export default class ScheduledMaintenanceOwnerUser 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,
@@ -153,6 +155,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
title: "User",
description:
"User that is the owner. This user will receive notifications. ",
example: "user-id-8c1d3e5f-a7b9-4c2e-9d6f-1a2b3c4d5e6f",
})
@ManyToOne(
() => {
@@ -190,6 +193,7 @@ export default class ScheduledMaintenanceOwnerUser 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,
@@ -220,6 +224,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
title: "ScheduledMaintenance",
description:
"Relation to ScheduledMaintenance Resource in which this object belongs",
example: "scheduled-maintenance-id-4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
})
@ManyToOne(
() => {
@@ -258,6 +263,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
title: "ScheduledMaintenance ID",
description:
"ID of your OneUptime ScheduledMaintenance in which this object belongs",
example: "4b6d8f0a-c2e4-6f8a-9c0d-1e2f3a4b5c6d",
})
@Column({
type: ColumnType.ObjectID,
@@ -288,6 +294,7 @@ export default class ScheduledMaintenanceOwnerUser 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(
() => {
@@ -323,6 +330,7 @@ export default class ScheduledMaintenanceOwnerUser 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,
@@ -348,6 +356,7 @@ export default class ScheduledMaintenanceOwnerUser 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(
() => {
@@ -379,6 +388,7 @@ export default class ScheduledMaintenanceOwnerUser 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,
@@ -407,6 +417,7 @@ export default class ScheduledMaintenanceOwnerUser extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,

11
Common/Models/DatabaseModels/ScheduledMaintenancePublicNote.ts
View File

@@ -134,6 +134,7 @@ export default class ScheduledMaintenancePublicNote 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,
@@ -200,6 +201,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
required: true,
title: "Scheduled Maintenance ID",
description: "ID of Scheduled Maintenance this resource belongs to",
example: "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
})
@Column({
type: ColumnType.ObjectID,
@@ -265,6 +267,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
})
@Column({
type: ColumnType.ObjectID,
@@ -311,6 +314,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-c3d4-e5f6a7b89012",
})
@Column({
type: ColumnType.ObjectID,
@@ -343,6 +347,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
type: TableColumnType.Markdown,
title: "Note",
description: "Notes in markdown",
example: "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
})
@Column({
type: ColumnType.Markdown,
@@ -427,6 +432,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
title: "Subscriber Notification Status",
description: "Status of notification sent to subscribers about this note",
defaultValue: StatusPageSubscriberNotificationStatus.Pending,
example: "Sent",
})
@Column({
type: ColumnType.ShortText,
@@ -461,6 +467,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
description:
"Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons",
required: false,
example: "Successfully sent notification to 150 subscribers",
})
@Column({
type: ColumnType.VeryLongText,
@@ -489,6 +496,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
title: "Should subscribers be notified?",
description: "Should subscribers be notified about this note?",
defaultValue: true,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -517,6 +525,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,
@@ -549,6 +558,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
title: "Note Posted At",
description: "Date and time when the note was posted",
type: TableColumnType.Date,
example: "2024-01-15T14:30:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -579,6 +589,7 @@ export default class ScheduledMaintenancePublicNote extends BaseModel {
description:
"Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message.",
required: false,
example: "C1234567890:1234567890.123456",
})
@Column({
type: ColumnType.LongText,

16
Common/Models/DatabaseModels/ScheduledMaintenanceStateTimeline.ts
View File

@@ -90,6 +90,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -127,6 +128,7 @@ export default class ScheduledMaintenanceStateTimeline 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,
@@ -157,6 +159,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
title: "Scheduled Maintenance",
description:
"Relation to Scheduled Maintenance Event this resource belongs to",
example: "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
})
@ManyToOne(
() => {
@@ -193,6 +196,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
required: true,
title: "Scheduled Maintenance ID",
description: "ID of Scheduled Maintenance this resource belongs to",
example: "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
})
@Column({
type: ColumnType.ObjectID,
@@ -223,6 +227,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
title: "Created by User",
description:
"Relation to User who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@ManyToOne(
() => {
@@ -258,6 +263,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@Column({
type: ColumnType.ObjectID,
@@ -278,6 +284,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@ManyToOne(
() => {
@@ -304,6 +311,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
})
@Column({
type: ColumnType.ObjectID,
@@ -339,6 +347,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
title: "Scheduled Maintenance State",
description:
"Which state does this event belongs to?. Relation to Scheduled Maintenance State",
example: "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
})
@ManyToOne(
() => {
@@ -380,6 +389,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
title: "Scheduled Maintenance State ID",
description:
" Scheduled Maintenance State ID. Which state does this event belongs to?",
example: "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
})
@Column({
type: ColumnType.ObjectID,
@@ -417,6 +427,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
description:
"Status of notification sent to subscribers about this scheduled maintenance state change",
defaultValue: StatusPageSubscriberNotificationStatus.Pending,
example: "Sent",
})
@Column({
type: ColumnType.ShortText,
@@ -451,6 +462,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
description:
"Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons",
required: false,
example: "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC",
})
@Column({
type: ColumnType.VeryLongText,
@@ -478,6 +490,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
type: TableColumnType.Boolean,
title: "Should subscribers be notified?",
description: "Should subscribers be notified about this state change?",
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -504,6 +517,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
isDefaultValueColumn: true,
title: "Are Owners Notified",
description: "Are owners notified of state change?",
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -532,6 +546,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Ends At",
description: "When did this status change end?",
example: "2024-01-16T04:00:00.000Z",
})
@Column({
type: ColumnType.Date,
@@ -560,6 +575,7 @@ export default class ScheduledMaintenanceStateTimeline extends BaseModel {
type: TableColumnType.Date,
title: "Starts At",
description: "When did this status change?",
example: "2024-01-16T02:00:00.000Z",
})
@Column({
type: ColumnType.Date,

20
Common/Models/DatabaseModels/ScheduledMaintenanceTemplate.ts
View File

@@ -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,7 @@ 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 +257,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 +292,7 @@ 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 +318,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 +385,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 +432,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 +643,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 +659,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 +692,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 +725,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 +777,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 +811,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 +844,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 +880,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 +916,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 +952,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 +987,7 @@ 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 +1021,7 @@ 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,

10
Common/Models/DatabaseModels/ServiceCatalogDependency.ts
View File

@@ -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,

10
Common/Models/DatabaseModels/ServiceCatalogMonitor.ts
View File

@@ -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,

10
Common/Models/DatabaseModels/ServiceCatalogOwnerTeam.ts
View File

@@ -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,

10
Common/Models/DatabaseModels/ServiceCatalogOwnerUser.ts
View File

@@ -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,

10
Common/Models/DatabaseModels/ServiceCatalogTelemetryService.ts
View File

@@ -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,

4
Common/Models/DatabaseModels/ShortLink.ts
View File

@@ -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,

30
Common/Models/DatabaseModels/SmsLog.ts
View File

@@ -76,6 +76,7 @@ export default class SmsLog extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -108,6 +109,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Project ID",
description: "ID of your OneUptime Project in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@Column({
type: ColumnType.ObjectID,
@@ -133,6 +135,7 @@ export default class SmsLog extends BaseModel {
title: "To Number",
description: "Phone Number SMS was sent to",
canReadOnRelationQuery: false,
example: "+1-555-123-4567",
})
@Column({
nullable: false,
@@ -159,6 +162,7 @@ export default class SmsLog extends BaseModel {
title: "From Number",
description: "Phone Number SMS was sent from",
canReadOnRelationQuery: false,
example: "+1-555-999-8888",
})
@Column({
nullable: true,
@@ -184,6 +188,7 @@ export default class SmsLog extends BaseModel {
title: "SMS Text",
description: "Text content of the message",
canReadOnRelationQuery: false,
example: "Alert: High CPU usage detected on your server. Please investigate immediately.",
})
@Column({
nullable: true,
@@ -207,6 +212,7 @@ export default class SmsLog extends BaseModel {
title: "Status Message",
description: "Status Message (if any)",
canReadOnRelationQuery: false,
example: "Message delivered successfully",
})
@Column({
nullable: true,
@@ -231,6 +237,7 @@ export default class SmsLog extends BaseModel {
title: "Status of the SMS",
description: "Status of the SMS sent",
canReadOnRelationQuery: false,
example: "Delivered",
})
@Column({
nullable: false,
@@ -257,6 +264,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: false,
isDefaultValueColumn: true,
defaultValue: 0,
example: 75,
})
@Column({
nullable: false,
@@ -283,6 +291,7 @@ export default class SmsLog extends BaseModel {
modelType: Incident,
title: "Incident",
description: "Incident associated with this SMS (if any)",
example: "b2c3d4e5-6789-01bc-def2-234567890abc",
})
@ManyToOne(
() => {
@@ -315,6 +324,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Incident ID",
description: "ID of Incident associated with this SMS (if any)",
example: "b2c3d4e5-6789-01bc-def2-234567890abc",
})
@Column({
type: ColumnType.ObjectID,
@@ -339,6 +349,7 @@ export default class SmsLog extends BaseModel {
modelType: User,
title: "User",
description: "User who initiated this SMS (if any)",
example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
})
@ManyToOne(
() => {
@@ -371,6 +382,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: true,
title: "User ID",
description: "ID of User who initiated this SMS (if any)",
example: "c3d4e5f6-789a-12cd-ef34-3456789abcde",
})
@Column({
type: ColumnType.ObjectID,
@@ -395,6 +407,7 @@ export default class SmsLog extends BaseModel {
modelType: Alert,
title: "Alert",
description: "Alert associated with this SMS (if any)",
example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
})
@ManyToOne(
() => {
@@ -427,6 +440,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Alert ID",
description: "ID of Alert associated with this SMS (if any)",
example: "d4e5f6a7-89ab-23de-f456-456789abcdef",
})
@Column({
type: ColumnType.ObjectID,
@@ -451,6 +465,7 @@ export default class SmsLog extends BaseModel {
modelType: ScheduledMaintenance,
title: "Scheduled Maintenance",
description: "Scheduled Maintenance associated with this SMS (if any)",
example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
})
@ManyToOne(
() => {
@@ -484,6 +499,7 @@ export default class SmsLog extends BaseModel {
title: "Scheduled Maintenance ID",
description:
"ID of Scheduled Maintenance associated with this SMS (if any)",
example: "e5f6a7b8-9abc-34ef-5678-56789abcdef0",
})
@Column({
type: ColumnType.ObjectID,
@@ -508,6 +524,7 @@ export default class SmsLog extends BaseModel {
modelType: StatusPage,
title: "Status Page",
description: "Status Page associated with this SMS (if any)",
example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
})
@ManyToOne(
() => {
@@ -540,6 +557,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Status Page ID",
description: "ID of Status Page associated with this SMS (if any)",
example: "f6a7b8c9-abcd-45ef-6789-6789abcdef01",
})
@Column({
type: ColumnType.ObjectID,
@@ -564,6 +582,7 @@ export default class SmsLog extends BaseModel {
modelType: StatusPageAnnouncement,
title: "Status Page Announcement",
description: "Status Page Announcement associated with this SMS (if any)",
example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
})
@ManyToOne(
() => {
@@ -597,6 +616,7 @@ export default class SmsLog extends BaseModel {
title: "Status Page Announcement ID",
description:
"ID of Status Page Announcement associated with this SMS (if any)",
example: "a7b8c9d0-bcde-56f0-789a-789abcdef012",
})
@Column({
type: ColumnType.ObjectID,
@@ -621,6 +641,7 @@ export default class SmsLog extends BaseModel {
modelType: OnCallDutyPolicy,
title: "On-Call Duty Policy",
description: "On-Call Duty Policy associated with this SMS (if any)",
example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
})
@ManyToOne(
() => {
@@ -653,6 +674,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: true,
title: "On-Call Duty Policy ID",
description: "ID of On-Call Duty Policy associated with this SMS (if any)",
example: "b8c9d0e1-cdef-67f1-89ab-89abcdef0123",
})
@Column({
type: ColumnType.ObjectID,
@@ -678,6 +700,7 @@ export default class SmsLog extends BaseModel {
title: "On-Call Duty Policy Escalation Rule",
description:
"On-Call Duty Policy Escalation Rule associated with this SMS (if any)",
example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
})
@ManyToOne(
() => {
@@ -712,6 +735,7 @@ export default class SmsLog extends BaseModel {
title: "On-Call Duty Policy Escalation Rule ID",
description:
"ID of On-Call Duty Policy Escalation Rule associated with this SMS (if any)",
example: "c9d0e1f2-def0-78f2-9abc-9abcdef01234",
})
@Column({
type: ColumnType.ObjectID,
@@ -737,6 +761,7 @@ export default class SmsLog extends BaseModel {
title: "On-Call Duty Policy Schedule",
description:
"On-Call Duty Policy Schedule associated with this SMS (if any)",
example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
})
@ManyToOne(
() => {
@@ -770,6 +795,7 @@ export default class SmsLog extends BaseModel {
title: "On-Call Duty Policy Schedule ID",
description:
"ID of On-Call Duty Policy Schedule associated with this SMS (if any)",
example: "d0e1f2a3-ef01-89f3-abcd-abcdef012345",
})
@Column({
type: ColumnType.ObjectID,
@@ -794,6 +820,7 @@ export default class SmsLog extends BaseModel {
modelType: Team,
title: "Team",
description: "Team associated with this SMS (if any)",
example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
})
@ManyToOne(
() => {
@@ -826,6 +853,7 @@ export default class SmsLog extends BaseModel {
canReadOnRelationQuery: true,
title: "Team ID",
description: "ID of Team associated with this SMS (if any)",
example: "e1f2a3b4-f012-9af4-bcde-bcdef0123456",
})
@Column({
type: ColumnType.ObjectID,
@@ -846,6 +874,7 @@ export default class SmsLog extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "f2a3b4c5-0123-abf5-cdef-cdef01234567",
})
@ManyToOne(
() => {
@@ -872,6 +901,7 @@ export default class SmsLog extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "f2a3b4c5-0123-abf5-cdef-cdef01234567",
})
@Column({
type: ColumnType.ObjectID,

13
Common/Models/DatabaseModels/StatusPageAnnouncementTemplate.ts
View File

@@ -107,6 +107,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
modelType: Project,
title: "Project",
description: "Relation to Project Resource in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@ManyToOne(
() => {
@@ -144,6 +145,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
canReadOnRelationQuery: true,
title: "Project ID",
description: "ID of your OneUptime Project in which this object belongs",
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
})
@Column({
type: ColumnType.ObjectID,
@@ -177,6 +179,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
type: TableColumnType.ShortText,
title: "Template Name",
description: "Name of the announcement template",
example: "Planned Upgrade Announcement",
})
@Column({
nullable: false,
@@ -210,6 +213,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
type: TableColumnType.LongText,
title: "Template Description",
description: "Description of the announcement template",
example: "This template is used for announcing planned system upgrades and improvements. It provides subscribers with advance notice of upcoming changes and expected impact on service availability.",
})
@Column({
nullable: true,
@@ -243,6 +247,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
type: TableColumnType.ShortText,
title: "Announcement Title",
description: "Title of the announcement",
example: "Scheduled System Upgrade - January 15, 2025",
})
@Column({
nullable: false,
@@ -276,6 +281,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
type: TableColumnType.Markdown,
title: "Announcement Description",
description: "Text of the announcement. This is in Markdown.",
example: "We will be performing a scheduled system upgrade on **January 15, 2025** from **2:00 AM to 4:00 AM EST**.\n\n## What to Expect\n\n- Brief service interruptions may occur during the maintenance window\n- All data will remain secure and intact\n- System performance improvements will be available after completion\n\n## Affected Services\n\n- API endpoints\n- Web dashboard\n- Mobile applications\n\nWe apologize for any inconvenience and appreciate your patience as we work to improve our services.",
})
@Column({
nullable: false,
@@ -309,6 +315,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
modelType: StatusPage,
title: "Status Pages",
description: "Status Pages to show this announcement on.",
example: [{ id: "c3d4e5f6-a7b8-9012-cdef-123456789012" }, { id: "d4e5f6a7-b8c9-0123-def1-234567890123" }],
})
@ManyToMany(
() => {
@@ -356,6 +363,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
title: "Monitors",
description:
"List of monitors affected by this announcement template. If none are selected, all subscribers will be notified.",
example: [{ id: "e5f6a7b8-c9d0-1234-ef12-345678901234" }, { id: "f6a7b8c9-d0e1-2345-f123-456789012345" }],
})
@ManyToMany(
() => {
@@ -403,6 +411,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
description:
"Should subscribers be notified about announcements created from this template?",
defaultValue: true,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -427,6 +436,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
title: "Created by User",
description:
"Relation to User who created this object (if this object was created by a User)",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@ManyToOne(
() => {
@@ -462,6 +472,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
})
@Column({
type: ColumnType.ObjectID,
@@ -487,6 +498,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
modelType: User,
description:
"Relation to User who deleted this object (if this object was deleted by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@ManyToOne(
() => {
@@ -513,6 +525,7 @@ export default class StatusPageAnnouncementTemplate extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
})
@Column({
type: ColumnType.ObjectID,

7
Common/Models/DatabaseModels/StatusPageFooterLink.ts
View File

@@ -132,6 +132,7 @@ export default class StatusPageFooterLink 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,
@@ -198,6 +199,7 @@ export default class StatusPageFooterLink extends BaseModel {
required: true,
title: "Status Page ID",
description: "ID of your Status Page resource where this object belongs",
example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
})
@Column({
type: ColumnType.ObjectID,
@@ -231,6 +233,7 @@ export default class StatusPageFooterLink extends BaseModel {
type: TableColumnType.ShortText,
title: "Title",
description: "Title of this resource",
example: "Privacy Policy",
})
@Column({
nullable: false,
@@ -264,6 +267,7 @@ export default class StatusPageFooterLink extends BaseModel {
type: TableColumnType.ShortURL,
title: "Link",
description: "URL to a website or any other resource on the internet",
example: "https://example.com/privacy",
})
@Column({
nullable: false,
@@ -330,6 +334,7 @@ export default class StatusPageFooterLink extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
})
@Column({
type: ColumnType.ObjectID,
@@ -396,6 +401,7 @@ export default class StatusPageFooterLink extends BaseModel {
type: TableColumnType.Number,
title: "Order",
description: "Order / Priority of this resource",
example: 1,
})
@Column({
type: ColumnType.Number,
@@ -412,6 +418,7 @@ export default class StatusPageFooterLink extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-c3d4-e5f6a7b89012",
})
@Column({
type: ColumnType.ObjectID,

6
Common/Models/DatabaseModels/StatusPageOwnerTeam.ts
View File

@@ -132,6 +132,7 @@ export default class StatusPageOwnerTeam 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,
@@ -199,6 +200,7 @@ export default class StatusPageOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "Team ID",
description: "ID of your OneUptime Team in which this object belongs",
example: "d4e5f6a7-b8c9-0123-d4e5-f6a7b8c90123",
})
@Column({
type: ColumnType.ObjectID,
@@ -265,6 +267,7 @@ export default class StatusPageOwnerTeam extends BaseModel {
canReadOnRelationQuery: true,
title: "StatusPage ID",
description: "ID of your OneUptime StatusPage in which this object belongs",
example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
})
@Column({
type: ColumnType.ObjectID,
@@ -330,6 +333,7 @@ export default class StatusPageOwnerTeam extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
})
@Column({
type: ColumnType.ObjectID,
@@ -386,6 +390,7 @@ export default class StatusPageOwnerTeam extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-c3d4-e5f6a7b89012",
})
@Column({
type: ColumnType.ObjectID,
@@ -414,6 +419,7 @@ export default class StatusPageOwnerTeam extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

6
Common/Models/DatabaseModels/StatusPageOwnerUser.ts
View File

@@ -131,6 +131,7 @@ export default class StatusPageOwnerUser 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,
@@ -198,6 +199,7 @@ export default class StatusPageOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "User ID",
description: "ID of your OneUptime User in which this object belongs",
example: "e5f6a7b8-c9d0-1234-e5f6-a7b8c9d01234",
})
@Column({
type: ColumnType.ObjectID,
@@ -264,6 +266,7 @@ export default class StatusPageOwnerUser extends BaseModel {
canReadOnRelationQuery: true,
title: "StatusPage ID",
description: "ID of your OneUptime StatusPage in which this object belongs",
example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
})
@Column({
type: ColumnType.ObjectID,
@@ -329,6 +332,7 @@ export default class StatusPageOwnerUser extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
})
@Column({
type: ColumnType.ObjectID,
@@ -385,6 +389,7 @@ export default class StatusPageOwnerUser extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-c3d4-e5f6a7b89012",
})
@Column({
type: ColumnType.ObjectID,
@@ -416,6 +421,7 @@ export default class StatusPageOwnerUser extends BaseModel {
title: "Are Owners Notified",
description: "Are owners notified of this resource ownership?",
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

13
Common/Models/DatabaseModels/StatusPageSso.ts
View File

@@ -126,6 +126,7 @@ export default class StatusPageSSO 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,
@@ -192,6 +193,7 @@ export default class StatusPageSSO extends BaseModel {
required: true,
title: "Status Page ID",
description: "ID of your Status Page resource where this object belongs",
example: "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
})
@Column({
type: ColumnType.ObjectID,
@@ -225,6 +227,7 @@ export default class StatusPageSSO extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "Corporate SSO",
})
@Column({
nullable: false,
@@ -257,6 +260,7 @@ export default class StatusPageSSO extends BaseModel {
required: true,
type: TableColumnType.LongText,
canReadOnRelationQuery: true,
example: "SSO configuration for status page authentication using SAML 2.0",
})
@Column({
nullable: false,
@@ -286,6 +290,7 @@ export default class StatusPageSSO extends BaseModel {
required: true,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "RSA-SHA256",
})
@Column({
nullable: false,
@@ -316,6 +321,7 @@ export default class StatusPageSSO extends BaseModel {
required: true,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "SHA256",
})
@Column({
nullable: false,
@@ -347,6 +353,7 @@ export default class StatusPageSSO extends BaseModel {
required: true,
type: TableColumnType.LongURL,
canReadOnRelationQuery: true,
example: "https://idp.example.com/saml/sso",
})
@Column({
nullable: false,
@@ -378,6 +385,7 @@ export default class StatusPageSSO extends BaseModel {
required: true,
type: TableColumnType.LongURL,
canReadOnRelationQuery: true,
example: "https://idp.example.com/saml/metadata",
})
@Column({
nullable: false,
@@ -408,6 +416,7 @@ export default class StatusPageSSO extends BaseModel {
required: true,
type: TableColumnType.VeryLongText,
canReadOnRelationQuery: true,
example: "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAKL0UG+mRKU...\n-----END CERTIFICATE-----",
})
@Column({
nullable: false,
@@ -470,6 +479,7 @@ export default class StatusPageSSO extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
})
@Column({
type: ColumnType.ObjectID,
@@ -526,6 +536,7 @@ export default class StatusPageSSO extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "c3d4e5f6-a7b8-9012-c3d4-e5f6a7b89012",
})
@Column({
type: ColumnType.ObjectID,
@@ -557,6 +568,7 @@ export default class StatusPageSSO extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -583,6 +595,7 @@ export default class StatusPageSSO extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

12
Common/Models/DatabaseModels/TableView.ts
View File

@@ -93,6 +93,7 @@ export default class TableView 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 TableView 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 TableView extends BaseModel {
canReadOnRelationQuery: true,
title: "Name",
description: "Any friendly name of this object",
example: "Production Monitors View",
})
@Column({
nullable: false,
@@ -193,6 +196,7 @@ export default class TableView extends BaseModel {
canReadOnRelationQuery: true,
title: "Table ID",
description: "ID of the table this view is for",
example: "Monitor",
})
@Column({
nullable: false,
@@ -224,6 +228,7 @@ export default class TableView extends BaseModel {
type: TableColumnType.LongText,
title: "Description",
description: "Friendly description that will help you remember",
example: "A table view for all production monitors with active alerts",
})
@Column({
nullable: true,
@@ -253,6 +258,7 @@ export default class TableView 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(
() => {
@@ -287,6 +293,7 @@ export default class TableView 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,
@@ -312,6 +319,7 @@ export default class TableView 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(
() => {
@@ -343,6 +351,7 @@ export default class TableView 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 TableView extends BaseModel {
type: TableColumnType.JSON,
canReadOnRelationQuery: true,
description: "Filters for this table view",
example: '{"status": "active", "priority": "high"}',
})
@Column({
type: ColumnType.JSON,
@@ -409,6 +419,7 @@ export default class TableView extends BaseModel {
type: TableColumnType.JSON,
canReadOnRelationQuery: true,
description: "Sort for this table view",
example: '{"createdAt": -1}',
})
@Column({
type: ColumnType.JSON,
@@ -443,6 +454,7 @@ export default class TableView extends BaseModel {
canReadOnRelationQuery: true,
description: "Items on page",
defaultValue: 10,
example: 10,
})
@Column({
type: ColumnType.Number,

12
Common/Models/DatabaseModels/TeamMember.ts
View File

@@ -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,

11
Common/Models/DatabaseModels/TeamPermission.ts
View File

@@ -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,

27
Common/Models/DatabaseModels/TelemetryException.ts
View File

@@ -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,7 @@ 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 +288,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 +322,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 +352,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 +387,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 +421,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 +461,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 +493,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 +525,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 +557,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 +589,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 +623,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 +662,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 +698,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 +737,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 +773,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 +812,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 +847,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 +886,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 +920,7 @@ export default class TelemetryException extends DatabaseBaseModel {
required: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,
@@ -930,6 +955,7 @@ export default class TelemetryException extends DatabaseBaseModel {
required: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,
@@ -964,6 +990,7 @@ export default class TelemetryException extends DatabaseBaseModel {
required: true,
type: TableColumnType.Number,
defaultValue: 1,
example: 42,
})
@Column({
type: ColumnType.Number,

9
Common/Models/DatabaseModels/TelemetryIngestionKey.ts
View File

@@ -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,7 @@ 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 +201,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 +235,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 +256,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 +283,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 +312,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,

15
Common/Models/DatabaseModels/TelemetryUsageBilling.ts
View File

@@ -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,

7
Common/Models/DatabaseModels/UserCall.ts
View File

@@ -79,6 +79,7 @@ class UserCall 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,
@@ -98,6 +99,7 @@ class UserCall extends BaseModel {
unique: false,
type: TableColumnType.Phone,
canReadOnRelationQuery: true,
example: "+1-555-987-6543",
})
@Column({
type: ColumnType.Phone,
@@ -143,6 +145,7 @@ class UserCall extends BaseModel {
type: TableColumnType.ObjectID,
title: "User ID",
description: "User ID who this email belongs to",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -189,6 +192,7 @@ class UserCall extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -235,6 +239,7 @@ class UserCall extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -253,6 +258,7 @@ class UserCall extends BaseModel {
description: "Is this verified?",
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -275,6 +281,7 @@ class UserCall extends BaseModel {
forceGetDefaultValueOnCreate: () => {
return Text.generateRandomNumber(6);
},
example: "123456",
})
@Column({
type: ColumnType.ShortText,

7
Common/Models/DatabaseModels/UserEmail.ts
View File

@@ -79,6 +79,7 @@ class UserEmail 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,
@@ -98,6 +99,7 @@ class UserEmail extends BaseModel {
unique: false,
type: TableColumnType.Email,
canReadOnRelationQuery: true,
example: "john.smith@example.com",
})
@Column({
type: ColumnType.Email,
@@ -143,6 +145,7 @@ class UserEmail extends BaseModel {
type: TableColumnType.ObjectID,
title: "User ID",
description: "User ID who this email belongs to",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -189,6 +192,7 @@ class UserEmail extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -235,6 +239,7 @@ class UserEmail extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -254,6 +259,7 @@ class UserEmail extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -276,6 +282,7 @@ class UserEmail extends BaseModel {
forceGetDefaultValueOnCreate: () => {
return Text.generateRandomNumber(6);
},
example: "123456",
})
@Column({
type: ColumnType.ShortText,

13
Common/Models/DatabaseModels/UserNotificationRule.ts
View File

@@ -83,6 +83,7 @@ class UserNotificationRule 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,
@@ -102,6 +103,7 @@ class UserNotificationRule extends BaseModel {
unique: false,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "Send Notification When Incident Created",
})
@Column({
type: ColumnType.ShortText,
@@ -146,6 +148,7 @@ class UserNotificationRule extends BaseModel {
type: TableColumnType.ObjectID,
title: "User ID",
description: "User ID who this email belongs to",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -192,6 +195,7 @@ class UserNotificationRule extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -238,6 +242,7 @@ class UserNotificationRule extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -284,6 +289,7 @@ class UserNotificationRule extends BaseModel {
canReadOnRelationQuery: true,
title: "User Call ID",
description: "ID of User Call in which this object belongs",
example: "9e8d7c6b-5a4f-3e2d-1c0b-9a8f7e6d5c4b",
})
@Column({
type: ColumnType.ObjectID,
@@ -330,6 +336,7 @@ class UserNotificationRule extends BaseModel {
canReadOnRelationQuery: true,
title: "User Push ID",
description: "ID of User Push in which this object belongs",
example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
})
@Column({
type: ColumnType.ObjectID,
@@ -376,6 +383,7 @@ class UserNotificationRule extends BaseModel {
canReadOnRelationQuery: true,
title: "User SMS ID",
description: "ID of User SMS in which this object belongs",
example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
})
@Column({
type: ColumnType.ObjectID,
@@ -423,6 +431,7 @@ class UserNotificationRule extends BaseModel {
canReadOnRelationQuery: true,
title: "User WhatsApp ID",
description: "ID of User WhatsApp in which this object belongs",
example: "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
})
@Column({
type: ColumnType.ObjectID,
@@ -469,6 +478,7 @@ class UserNotificationRule extends BaseModel {
canReadOnRelationQuery: true,
title: "User Email ID",
description: "ID of User Email in which this object belongs",
example: "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
})
@Column({
type: ColumnType.ObjectID,
@@ -491,6 +501,7 @@ class UserNotificationRule extends BaseModel {
title: "Notify After Minutes",
description:
"How long should we wait before sending a notification to the user after the event has occurred?",
example: 5,
})
@Column({
type: ColumnType.Number,
@@ -538,6 +549,7 @@ class UserNotificationRule extends BaseModel {
canReadOnRelationQuery: true,
title: "Incident Severity ID",
description: "ID of Incident Severity in which this object belongs",
example: "5e6f7a8b-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
})
@Column({
type: ColumnType.ObjectID,
@@ -587,6 +599,7 @@ class UserNotificationRule extends BaseModel {
canReadOnRelationQuery: true,
title: "Alert Severity ID",
description: "ID of Alert Severity in which this object belongs",
example: "6f7a8b9c-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
})
@Column({
type: ColumnType.ObjectID,

10
Common/Models/DatabaseModels/UserNotificationSetting.ts
View File

@@ -78,6 +78,7 @@ class UserNotificationSetting 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,
@@ -97,6 +98,7 @@ class UserNotificationSetting extends BaseModel {
unique: false,
type: TableColumnType.ShortText,
canReadOnRelationQuery: true,
example: "Incident Created",
})
@Column({
type: ColumnType.ShortText,
@@ -141,6 +143,7 @@ class UserNotificationSetting extends BaseModel {
type: TableColumnType.ObjectID,
title: "User ID",
description: "User ID who this email belongs to",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -187,6 +190,7 @@ class UserNotificationSetting extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -233,6 +237,7 @@ class UserNotificationSetting extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -250,6 +255,7 @@ class UserNotificationSetting extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -266,6 +272,7 @@ class UserNotificationSetting extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,
@@ -282,6 +289,7 @@ class UserNotificationSetting extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,
@@ -298,6 +306,7 @@ class UserNotificationSetting extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -314,6 +323,7 @@ class UserNotificationSetting extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: false,
})
@Column({
type: ColumnType.Boolean,

27
Common/Models/DatabaseModels/UserOnCallLog.ts
View File

@@ -91,6 +91,7 @@ export default class UserOnCallLog extends BaseModel {
type: TableColumnType.ObjectID,
title: "User ID",
description: "User ID who this log belongs to",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -134,6 +135,7 @@ export default class UserOnCallLog extends BaseModel {
type: TableColumnType.ObjectID,
title: "Which team did the user belong to when the alert was sent?",
description: "Which team did the user belong to when the alert was sent?",
example: "8d0e1f2a-3b4c-5d6e-7f8a-9b0c1d2e3f4a",
})
@Column({
type: ColumnType.ObjectID,
@@ -180,6 +182,7 @@ export default class UserOnCallLog 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,
@@ -228,6 +231,7 @@ export default class UserOnCallLog extends BaseModel {
title: "On-Call Policy ID",
description:
"ID of your On-Call Policy which belongs to this execution log event.",
example: "9e1f2a3b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
})
@Column({
type: ColumnType.ObjectID,
@@ -277,6 +281,7 @@ export default class UserOnCallLog extends BaseModel {
title: "On-Call Policy Execution Log ID",
description:
"ID of your On-Call Policy execution log which belongs to this log event.",
example: "0f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
})
@Column({
type: ColumnType.ObjectID,
@@ -326,6 +331,7 @@ export default class UserOnCallLog extends BaseModel {
title: "On-Call Policy Escalation Rule ID",
description:
"ID of your On-Call Policy Escalation Rule which belongs to this log event.",
example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
})
@Column({
type: ColumnType.ObjectID,
@@ -372,6 +378,7 @@ export default class UserOnCallLog extends BaseModel {
required: false,
description:
"ID of the incident which triggered this on-call escalation policy.",
example: "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
})
@Column({
type: ColumnType.ObjectID,
@@ -417,6 +424,7 @@ export default class UserOnCallLog extends BaseModel {
required: false,
description:
"ID of the Alert which triggered this on-call escalation policy.",
example: "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
})
@Column({
type: ColumnType.ObjectID,
@@ -436,6 +444,7 @@ export default class UserOnCallLog extends BaseModel {
title: "Status",
description: "Status of this execution",
canReadOnRelationQuery: false,
example: "Success",
})
@Column({
nullable: false,
@@ -455,6 +464,7 @@ export default class UserOnCallLog extends BaseModel {
title: "Notification Event Type",
description: "Notification Event Type of this execution",
canReadOnRelationQuery: false,
example: "Incident Created",
})
@Column({
nullable: false,
@@ -504,6 +514,7 @@ export default class UserOnCallLog extends BaseModel {
title: "On-Call Policy Execution Log ID",
description:
"ID of your On-Call Policy Execution Log where this timeline event belongs.",
example: "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
})
@Column({
type: ColumnType.ObjectID,
@@ -523,6 +534,7 @@ export default class UserOnCallLog extends BaseModel {
title: "Status Message",
description: "Status message of this execution",
canReadOnRelationQuery: false,
example: "Notification sent successfully via email to user",
})
@Column({
nullable: false,
@@ -568,6 +580,7 @@ export default class UserOnCallLog extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -614,6 +627,7 @@ export default class UserOnCallLog extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -659,6 +673,7 @@ export default class UserOnCallLog extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who acknowledged this object (if this object was acknowledged by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -673,7 +688,10 @@ export default class UserOnCallLog extends BaseModel {
update: [],
})
@TableColumn({ type: TableColumnType.Date })
@TableColumn({
type: TableColumnType.Date,
example: "2024-01-15T10:30:00Z",
})
@Column({
type: ColumnType.Date,
nullable: true,
@@ -693,7 +711,10 @@ export default class UserOnCallLog extends BaseModel {
read: [],
update: [],
})
@TableColumn({ type: TableColumnType.JSON })
@TableColumn({
type: TableColumnType.JSON,
example: { "rule-1": "2024-01-15T10:30:00Z", "rule-2": "2024-01-15T10:35:00Z" },
})
@Column({
type: ColumnType.JSON,
nullable: true,
@@ -738,6 +759,7 @@ export default class UserOnCallLog extends BaseModel {
title: "On Call Schedule ID",
description:
"Which schedule ID did the user belong to when the alert was sent?",
example: "5e6f7a8b-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
})
@Column({
type: ColumnType.ObjectID,
@@ -781,6 +803,7 @@ export default class UserOnCallLog extends BaseModel {
type: TableColumnType.ObjectID,
title: "Overridden by User ID",
description: "User ID who overrode this alert",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,

7
Common/Models/DatabaseModels/UserSMS.ts
View File

@@ -79,6 +79,7 @@ class UserSMS 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,
@@ -98,6 +99,7 @@ class UserSMS extends BaseModel {
unique: false,
type: TableColumnType.Phone,
canReadOnRelationQuery: true,
example: "+1-555-123-4567",
})
@Column({
type: ColumnType.Phone,
@@ -143,6 +145,7 @@ class UserSMS extends BaseModel {
type: TableColumnType.ObjectID,
title: "User ID",
description: "User ID who this email belongs to",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -189,6 +192,7 @@ class UserSMS extends BaseModel {
title: "Created by User ID",
description:
"User ID who created this object (if this object was created by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -235,6 +239,7 @@ class UserSMS extends BaseModel {
title: "Deleted by User ID",
description:
"User ID who deleted this object (if this object was deleted by a User)",
example: "7c9d8e0f-a1b2-4c3d-9e5f-8a7b9c0d1e2f",
})
@Column({
type: ColumnType.ObjectID,
@@ -254,6 +259,7 @@ class UserSMS extends BaseModel {
isDefaultValueColumn: true,
type: TableColumnType.Boolean,
defaultValue: false,
example: true,
})
@Column({
type: ColumnType.Boolean,
@@ -276,6 +282,7 @@ class UserSMS extends BaseModel {
forceGetDefaultValueOnCreate: () => {
return Text.generateRandomNumber(6);
},
example: "123456",
})
@Column({
type: ColumnType.ShortText,