diff --git a/apps/server/static/openapi.yaml b/apps/server/static/openapi.yaml index a8fcfe750..047485093 100644 --- a/apps/server/static/openapi.yaml +++ b/apps/server/static/openapi.yaml @@ -172,7 +172,9 @@ components: type: string title: message minLength: 1 - description: Message describing the maintenance (required). + description: |- + Message describing the maintenance (required). Posted as the first + maintenance update. from: type: string examples: @@ -340,7 +342,7 @@ components: message: type: string title: message - description: Message describing the maintenance. + description: Message of the newest maintenance update. from: type: string title: from @@ -390,7 +392,7 @@ components: message: type: string title: message - description: Message describing the maintenance. + description: Message of the newest maintenance update. from: type: string title: from @@ -471,7 +473,7 @@ components: - string - "null" title: message - description: New message for the maintenance (optional). + description: Replaces the message of the newest maintenance update (optional). from: type: - string diff --git a/packages/proto/gen/openapi.yaml b/packages/proto/gen/openapi.yaml index a8fcfe750..047485093 100644 --- a/packages/proto/gen/openapi.yaml +++ b/packages/proto/gen/openapi.yaml @@ -172,7 +172,9 @@ components: type: string title: message minLength: 1 - description: Message describing the maintenance (required). + description: |- + Message describing the maintenance (required). Posted as the first + maintenance update. from: type: string examples: @@ -340,7 +342,7 @@ components: message: type: string title: message - description: Message describing the maintenance. + description: Message of the newest maintenance update. from: type: string title: from @@ -390,7 +392,7 @@ components: message: type: string title: message - description: Message describing the maintenance. + description: Message of the newest maintenance update. from: type: string title: from @@ -471,7 +473,7 @@ components: - string - "null" title: message - description: New message for the maintenance (optional). + description: Replaces the message of the newest maintenance update (optional). from: type: - string diff --git a/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts b/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts index 797b63b8c..1942a1f04 100644 --- a/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts +++ b/packages/proto/gen/ts/openstatus/maintenance/v1/maintenance_pb.ts @@ -89,7 +89,7 @@ export type MaintenanceSummary = Message<"openstatus.maintenance.v1.MaintenanceS title: string; /** - * Message describing the maintenance. + * Message of the newest maintenance update. * * @generated from field: string message = 3; */ @@ -166,7 +166,7 @@ export type Maintenance = Message<"openstatus.maintenance.v1.Maintenance"> & { title: string; /** - * Message describing the maintenance. + * Message of the newest maintenance update. * * @generated from field: string message = 3; */ diff --git a/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts b/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts index 282eb2938..045c9d254 100644 --- a/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts +++ b/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts @@ -30,7 +30,8 @@ export type CreateMaintenanceRequest = Message<"openstatus.maintenance.v1.Create title: string; /** - * Message describing the maintenance (required). + * Message describing the maintenance (required). Posted as the first + * maintenance update. * * @generated from field: string message = 2; */ @@ -226,7 +227,7 @@ export type UpdateMaintenanceRequest = Message<"openstatus.maintenance.v1.Update title?: string | undefined; /** - * New message for the maintenance (optional). + * Replaces the message of the newest maintenance update (optional). * * @generated from field: optional string message = 3; */