diff --git a/proto/notifications/notification.proto b/proto/notifications/notification.proto new file mode 100644 index 0000000000000000000000000000000000000000..3b34f7f26c073f575105411be1cc976a1832000e --- /dev/null +++ b/proto/notifications/notification.proto @@ -0,0 +1,54 @@ +syntax = "proto3"; + +import "google/protobuf/empty.proto"; +import "common/common.proto"; +import "google/protobuf/timestamp.proto"; + +option go_package = "git.perx.ru/perxis/perxis-go/proto/notifications;notifications"; + +package notifications; + +// Сообщение для уведомления +message Notification { + string id = 1; // Уникальный идентификатор уведомления + string recipients = 2; // Рдентификатор пользователя или сервиса получателя + string title = 3; // Заголовок уведомления + string message = 4; // Текст уведомления + google.protobuf.Timestamp created_at = 5; // Время создания + bool is_read = 6; // Статус прочтения +} + +// Отправить уведомление +message SendRequest { + Notification notification = 1; +} + +// Запрос РЅР° получение уведомлений +message FindRequest { + string recipient = 1; + common.FindOptions opts = 2; +} + +// Ответ РЅР° получение уведомлений +message FindResponse { + repeated Notification notifications = 1; +} + +// Пометка уведомлений как прочитанных +message MarkAsReadRequest { + string recipient = 1; + repeated string notification_ids = 2; +} + +// Сервис уведомлений +service Notifications { + + // Отправка уведомления + rpc Send(SendRequest) returns(google.protobuf.Empty) {}; + + // Получение уведомлений, поле recipients РІ Notification всегда содержит только получателя РёР· запроса + rpc List(FindRequest) returns (FindResponse); + + // Пометка уведомлений как прочитанных + rpc MarkAsRead(MarkAsReadRequest) returns(google.protobuf.Empty) {}; +}