docs(integrator): v2.x.x update — workflow API + full changelog + schema extensions
This commit is contained in:
@@ -138,7 +138,63 @@ deployment v2 — следи за анонсами от Ordinis team.
|
||||
4. **Document FK в displayName** — `"description": "FK на satellite_type
|
||||
через code"` помогает при ревью schemas.
|
||||
|
||||
## Связанные schema extensions
|
||||
|
||||
### `x-localized` — мультиязычные поля
|
||||
|
||||
```json
|
||||
{ "type": "object", "x-localized": true }
|
||||
```
|
||||
|
||||
См. [read-endpoints.md](read-endpoints.md) `?lang=` параметр.
|
||||
|
||||
### `x-section` — bucketing полей в admin-UI form
|
||||
|
||||
Hint для admin-UI: в какую визуальную секцию формы (`identity`,
|
||||
`references`, `description`, `dates`, `geometry`, `physical`, `extra`,
|
||||
либо custom string) сгруппировать поле.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "number",
|
||||
"x-section": "orbital_geometry"
|
||||
}
|
||||
```
|
||||
|
||||
Если `x-section` не задан, admin-UI применяет эвристику:
|
||||
- `x-references` → `references`
|
||||
- `x-localized` → `description`
|
||||
- `format=date|date-time` → `dates`
|
||||
- key matches `/^(geo|geom|wkt|lon|lng|lat|altitude|coord)/` → `geometry`
|
||||
- `required` → `identity`
|
||||
- else → `extra`
|
||||
|
||||
Predefined IDs получают i18n labels (Связи / Описание / Даты / Геометрия /
|
||||
Физические параметры / Идентификация / Дополнительно). Custom IDs
|
||||
humanize'ятся: `orbital_geometry` → `Orbital Geometry`.
|
||||
|
||||
Только UI hint — backend не validate'ит и не reject'ит unknown values.
|
||||
|
||||
### `x-id-source` — авто-derive businessKey
|
||||
|
||||
```json
|
||||
{ "x-id-source": "code" }
|
||||
```
|
||||
|
||||
При CREATE businessKey берётся из `data.code` automatically (UI скрывает
|
||||
поле). См. ReferenceValidator.
|
||||
|
||||
### `x-unique` — уникальность поля в dict'е
|
||||
|
||||
```json
|
||||
{ "type": "string", "x-unique": true }
|
||||
```
|
||||
|
||||
Backend enforce'ит при CREATE/UPDATE. Используется для `code` полей в
|
||||
target dicts которые ссылаются по `x-references`.
|
||||
|
||||
## Дальше
|
||||
|
||||
- [Bundle cuod](bundle-cuod.md) — список текущих FK в проде
|
||||
- [События](events.md) — учитывай cascade closure при инвалидации
|
||||
- [Schema workflow](schema-workflow.md) — как менять schema через approval flow
|
||||
|
||||
Reference in New Issue
Block a user