From da990ad04653c8ffaa48a7f53050485cce18673d Mon Sep 17 00:00:00 2001
From: "a.petraki" <a.petraki@perx.ru>
Date: Fri, 16 Aug 2024 13:50:08 +0300
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D1=80=D0=B0=D0=B1=D0=BE=D1=82?=
 =?UTF-8?q?=D0=B0=D0=BD=D0=BE=20=D0=BE=D0=BF=D0=B8=D1=81=D0=B0=D0=BD=D0=B8?=
 =?UTF-8?q?=D0=B5=20=D1=80=D0=B0=D0=B1=D0=BE=D1=82=D1=8B=20=D0=BC=D0=B5?=
 =?UTF-8?q?=D1=82=D0=BE=D0=B4=D0=BE=D0=B2/=D0=BF=D0=BE=D0=BB=D0=B5=D0=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 proto/items/items.proto     | 13 +++++++++----
 proto/locales/locales.proto | 35 +++++++++++++++++++++++++++--------
 2 files changed, 36 insertions(+), 12 deletions(-)

diff --git a/proto/items/items.proto b/proto/items/items.proto
index a8cc3c8..15b86c6 100644
--- a/proto/items/items.proto
+++ b/proto/items/items.proto
@@ -87,13 +87,13 @@ message Item {
   // Для удаления переводов реализована следующая логика:
   // - {"lang":nil|{}} - сброс перевода для языка
   // - {"lang":map{...}} - установка перевода для языка
-  // - {"lang":map{...}, "*":nil} - установка перевода для языка, сброс остальных переводов
+  // - {"lang":map{...}, "*":nil} - установка перевода для языка (одного или нескольких), сброс остальных переводов
   // - {"*":nil} - сброс всех переводов
   map<string, google.protobuf.Struct> translations = 12;
 
   // Список идентификаторов локалей, для которых есть переводы
-  // Соотвествует списку переводов в translations, при получении записи всегда возвращается
-  // полный список. Невозможно обновить вручную: формируется системой
+  // Соответствует списку переводов в translations, при получении записи всегда возвращается
+  // полный список. Невозможно обновить вручную, формируется системой
   repeated string translations_ids = 101;
 }
 
@@ -152,7 +152,12 @@ message FindOptions {
   bool regular = 4;
   bool hidden = 5;
   bool templates = 6;
-  string locale_id = 7; // Язык перевода который будет использоваться. Если не указан, то возвращаются данные для языка по умолчанию
+
+  // Язык перевода, для которого нужно выполнить запрос. По умолчанию если перевод для запрашиваемого
+  // поля не существует, то поиск проходит по fallback-языку (если указан и существует) или по основным данным.
+  //
+  // Если не указан, то возвращаются данные для языка по умолчанию
+  string locale_id = 7;
 
   // Список идентификаторов переводов/локалей, которых должны быть включены в результат
   // Возможно указание '*' для получения всех переводов
diff --git a/proto/locales/locales.proto b/proto/locales/locales.proto
index a2aa0e2..883243b 100644
--- a/proto/locales/locales.proto
+++ b/proto/locales/locales.proto
@@ -6,15 +6,33 @@ option go_package = "git.perx.ru/perxis/perxis-go/proto/locales;locales";
 
 package content.locales;
 
+// Locale содержит информацию и настройки для языка
 message Locale {
-  string id = 1; // Идентификатор локали, генерируется автоматически. Для локали по умолчанию устанавливается как "default".
-  string space_id = 2; // Идентификатор пространства.
-  string name = 3; // Название локали. Опционально, заполняется автоматически (Пример: russian, english)
-  string native_name = 4; // Название локали на языке локали. Опционально, заполняется автоматически  (Пример: Русский, English)
-  string code = 5; // Код локали https://en.wikipedia.org/wiki/IETF_language_tag
-  string fallback = 6; // Идентификатор локали, который будет использоваться при отсутствии перевода
+  // Идентификатор локали, генерируется автоматически.
+  //
+  // В пространстве всегда существует одна локаль по умолчанию, для нее идентификатор устанавливается `default`.
+  // `default`-локаль содержит настройки основных данных записи. Ее нельзя удалить, сделать `no_publish` или `disabled`
+  // и для нее нельзя установить `fallback`-локаль.
+  string id = 1;
+
+  // Идентификатор пространства локали.
+  string space_id = 2;
+
+  // Название локали. Опционально: заполняется автоматически, если не было передано (Пример: russian, english)
+  string name = 3;
+
+  // Название локали на языке локали. Опционально, заполняется автоматически  (Пример: Русский, English)
+  string native_name = 4;
+
+  // Код локали https://en.wikipedia.org/wiki/IETF_language_tag. Не является уникальным
+  string code = 5;
+
+  // Идентификатор локали, который будет использоваться при отсутствии перевода. Допускаются цепочки, но при
+  // получении перевода будут использованы только данные основной, fallback и запрошенной локали. Не допускается
+  // кольцевая зависимость локалей.
+  string fallback = 6;
   string direction = 7; // Направление письма - слева направо (ltr) или справа налево (rtl). По умолчанию устанавливается ltr.
-  int64 weight = 8; // Вес локали.
+  int64 weight = 8; // Вес локали. Чем больше, тем ниже приоритет
 
   bool no_publish = 100; // Не публиковать контент данной локали. Не будет доступен контент через Delivery API. (кроме default)
   bool disabled = 101; // Запретить использование локали. Нельзя создавать и редактировать контент для данной локали (кроме default)
@@ -51,7 +69,8 @@ service Locales {
   // Обновить локаль
   rpc Update(UpdateRequest) returns(google.protobuf.Empty) {}
 
-  // Получить список локалей
+  // Получить список локалей. В пространстве всегда есть одна локаль по умолчанию.
+  // Результат возвращается с сортировкой по [ weight, name ]
   rpc List(ListRequest) returns(ListResponse) {}
 
   // Удалить локаль
-- 
GitLab