@oneuptime/common 9.2.15 → 9.2.16

package/Models/DatabaseModels/StatusPageOwnerUser.ts

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

package/Models/DatabaseModels/StatusPageResource.ts

@@ -131,6 +131,7 @@ export default class StatusPageResource 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,
@@ -197,6 +198,7 @@ export default class StatusPageResource extends BaseModel {
     required: true,
     title: "Status Page ID",
     description: "ID of your Status Page resource where this object belongs",
+    example: "f6a7b8c9-d0e1-2345-6789-abcdef012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -272,6 +274,7 @@ export default class StatusPageResource extends BaseModel {
     required: false,
     title: "Monitor ID",
     description: "Relation to Monitor ID Resource in which this object belongs",
+    example: "a7b8c9d0-e1f2-3456-789a-bcdef0123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -349,6 +352,7 @@ export default class StatusPageResource extends BaseModel {
     title: "Monitor Group ID",
     description:
       "Relation to Monitor Group ID Resource in which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-89ab-cdef01234567",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -425,6 +429,7 @@ export default class StatusPageResource extends BaseModel {
     required: false,
     title: "Group ID",
     description: "Does this monitor belong to a status page group?",
+    example: "c9d0e1f2-a3b4-5678-9abc-def012345678",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -458,6 +463,7 @@ export default class StatusPageResource extends BaseModel {
     type: TableColumnType.ShortText,
     title: "Display Name",
     description: "Display name of the monitor on the Status Page",
+    example: "API Server",
   })
   @Column({
     nullable: false,
@@ -492,6 +498,7 @@ export default class StatusPageResource extends BaseModel {
     title: "Display Description",
     description:
       "Display description of the monitor on the Status Page. This is in markdown format.",
+    example: "Main API server handling all REST requests",
   })
   @Column({
     nullable: true,
@@ -721,6 +728,7 @@ export default class StatusPageResource extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "d0e1f2a3-b4c5-6789-abcd-ef0123456789",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -798,6 +806,7 @@ export default class StatusPageResource extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "e1f2a3b4-c5d6-789a-bcde-f01234567890",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/StatusPageSso.ts

@@ -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,8 @@ 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 +480,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 +537,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 +569,7 @@ export default class StatusPageSSO extends BaseModel {
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,
     defaultValue: false,
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -583,6 +596,7 @@ export default class StatusPageSSO extends BaseModel {
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,
     defaultValue: false,
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/StatusPageSubscriber.ts

@@ -141,6 +141,7 @@ export default class StatusPageSubscriber 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,
@@ -207,6 +208,7 @@ export default class StatusPageSubscriber extends BaseModel {
     required: true,
     title: "Status Page ID",
     description: "ID of your Status Page resource where this object belongs",
+    example: "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -241,6 +243,7 @@ export default class StatusPageSubscriber extends BaseModel {
     type: TableColumnType.Email,
     title: "Email",
     description: "Email address of the subscriber.",
+    example: "subscriber@example.com",
   })
   @Column({
     nullable: true,
@@ -311,6 +314,7 @@ export default class StatusPageSubscriber extends BaseModel {
     type: TableColumnType.ShortURL,
     title: "Webhook",
     description: "Webhook to ping when events happen on Status Page",
+    example: "https://example.com/webhook",
   })
   @Column({
     nullable: true,
@@ -495,6 +499,7 @@ export default class StatusPageSubscriber 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-234567890abc",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/TableView.ts

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

package/Models/DatabaseModels/Team.ts

@@ -131,6 +131,7 @@ export default class Team 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 +165,7 @@ export default class Team extends BaseModel {
     title: "Name",
     description: "Any friendly name of this object",
     canReadOnRelationQuery: true,
+    example: "Engineering Team",
   })
   @Column({
     nullable: false,
@@ -195,6 +197,8 @@ export default class Team extends BaseModel {
     type: TableColumnType.LongText,
     title: "Description",
     description: "Friendly description that will help you remember",
+    example:
+      "Team responsible for backend services and infrastructure management",
   })
   @Column({
     nullable: true,
@@ -285,6 +289,7 @@ export default class Team 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,
@@ -331,6 +336,7 @@ export default class Team 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,
@@ -356,6 +362,7 @@ export default class Team extends BaseModel {
     title: "Permissions Editable",
     description:
       "Can you edit team permissions? Teams auto-created for you are uneditable but you should be able to edit permissions on the team you create",
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -380,6 +387,7 @@ export default class Team extends BaseModel {
     title: "Team Deleteable",
     description:
       "Can you delete this team? Teams auto-created for you are not deleteable but you should be able to delete permissions on the team you create",
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -404,6 +412,7 @@ export default class Team extends BaseModel {
     title: "Should have one member?",
     description:
       "Can this team have no members? Owner team should have at least 1 member, other teams can have no members",
+    example: false,
   })
   @Column({
     type: ColumnType.Boolean,
@@ -428,6 +437,7 @@ export default class Team extends BaseModel {
     title: "Team Editable",
     description:
       "Can you edit team? Teams auto-created for you are uneditable but you should be able to edit on the team you create",
+    example: true,
   })
   @Column({
     type: ColumnType.Boolean,

package/Models/DatabaseModels/TeamMember.ts

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

package/Models/DatabaseModels/TeamPermission.ts

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