Skip to content

Commit 4299850

Browse files
committed
4.4.1: API definition
1 parent 87aec28 commit 4299850

File tree

10 files changed

+3890
-282
lines changed

10 files changed

+3890
-282
lines changed

components/public-api/gitpod/v1/organization.proto

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,12 @@ service OrganizationService {
153153

154154
// SetOrganizationMaintenanceMode sets the maintenance mode status for an organization.
155155
rpc SetOrganizationMaintenanceMode(SetOrganizationMaintenanceModeRequest) returns (SetOrganizationMaintenanceModeResponse) {}
156+
157+
// GetScheduledMaintenanceNotification retrieves the scheduled maintenance notification settings for an organization.
158+
rpc GetScheduledMaintenanceNotification(GetScheduledMaintenanceNotificationRequest) returns (GetScheduledMaintenanceNotificationResponse) {}
159+
160+
// SetScheduledMaintenanceNotification sets the scheduled maintenance notification for an organization.
161+
rpc SetScheduledMaintenanceNotification(SetScheduledMaintenanceNotificationRequest) returns (SetScheduledMaintenanceNotificationResponse) {}
156162
}
157163

158164
message ListOrganizationWorkspaceClassesRequest {
@@ -408,3 +414,37 @@ message SetOrganizationMaintenanceModeResponse {
408414
// enabled indicates the new maintenance mode status after the update.
409415
bool enabled = 1;
410416
}
417+
418+
message GetScheduledMaintenanceNotificationRequest {
419+
// organization_id is the ID of the organization to retrieve the notification settings for.
420+
string organization_id = 1;
421+
}
422+
423+
message GetScheduledMaintenanceNotificationResponse {
424+
// is_enabled indicates whether the scheduled maintenance notification is enabled.
425+
bool is_enabled = 1;
426+
427+
// message is the custom message stored, if any. Empty or not present if no custom message is set.
428+
// The frontend will use its own default if this is empty/undefined and is_enabled is true.
429+
string message = 2;
430+
}
431+
432+
message SetScheduledMaintenanceNotificationRequest {
433+
// organization_id is the ID of the organization to set the notification settings for.
434+
string organization_id = 1;
435+
436+
// is_enabled indicates whether the scheduled maintenance notification should be enabled or disabled.
437+
bool is_enabled = 2;
438+
439+
// custom_message is the user-provided custom message for the notification.
440+
// If not provided or empty, the backend stores undefined/empty for the message.
441+
optional string custom_message = 3;
442+
}
443+
444+
message SetScheduledMaintenanceNotificationResponse {
445+
// is_enabled indicates the new notification enabled status after the update.
446+
bool is_enabled = 1;
447+
448+
// message is the custom message that is now stored, if any.
449+
optional string message = 2;
450+
}

components/public-api/go/v1/organization.pb.go

Lines changed: 549 additions & 211 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/public-api/go/v1/organization_grpc.pb.go

Lines changed: 76 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)