updates

pages/api-component.md

@@ -29,15 +29,16 @@ spec:
 
 Здесь,
 
-- `metadata.name` - имя API-компонента, должно быть уникальным среди API-компонентов в одном модуле
+- <тип API> - см. ниже;
-- `metadata.namespace` - полное название приложения
+- `metadata.name` - имя API-компонента, должно быть уникальным среди API-компонентов в одном модуле;
-- `spec.published` - "включен" ли API - возможно добавить API-компонент, но временно его "выключить" - тогда запросы к нему не будут работать.
+- `metadata.namespace` - полное название приложения;
-- `spec.restfulAPI` - раздел настроек доступа. Поддерживается базовая авторизация и Open ID Connect.
+- `spec.published` - "включен" ли API - возможно добавить API-компонент, но временно его "выключить" - тогда запросы к нему не будут работать;
+- `spec.restfulAPI` - раздел настроек доступа. Поддерживается базовая авторизация и Open ID Connect;
 - `appname-apis-cred` - имя секрета, которое может быть любым.
 
 ## Типы API-компонентов
 
-Выше в шаблоне комментарий "<вид API>" должен быть заменён одной из секций ниже в зависимости от типа API-компонента.
+Выше в шаблоне комментарий "<тип API>" должен быть заменён одной из секций ниже в зависимости от типа API-компонента.
 
 ### Файловый API
 
@@ -103,9 +104,24 @@ spec:
     auth:
       identityPassThrough: true
       oidc: {}
+```
+
+В самом простом случае поле `oidc` можно оставить пустым словарём - `oidc: {}`. Также можно контролировать настройки OIDC:
+
+- `groups` - список разрешённых групп
+```yaml
+      oidc:
         groups: ["/group1"]
-        # enabled: false # default - true
+```
-        # roles: ["/test"]
+- `roles` - список разрешённых ролей
+```yaml
+      oidc:
+        roles: ["/test"]
+```
+- `enabled` - включена ли OIDC аутентификация (по умолчанию включена, указанием этого пункта можно выключить)
+```yaml
+      oidc: {}
+        enabled: false # default - true
 ```
 
 ## ComponentLink
@@ -140,7 +156,7 @@ spec:
 
 Секрет может выглядеть вот так. В нём перечислены имена пользователей, которым будет предоставлен доступ к API, указанному в ComponentLink. Будут созданы специальные группы в KeyCloak, в которые будут добавлены указанные пользователи.
 
-```
+```yaml
 apiVersion: v1
 kind: Secret
 metadata:
@@ -156,12 +172,3 @@ stringData:
     robot1
     robot2
 ```
-
-
-
-
-В самом простом случае поле `oidc` можно оставить пустым словарём - `oidc: {}`. Также можно контролировать настройки OIDC:
-
-- `groups` - список разрешённых групп
-- `roles` - список разрешённых ролей
-- `enabled` - включена ли OIDC аутентификация (по умолчанию включена, указанием этого пункта можно выключить)