@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc-test.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NOTICE +27 -0
- package/documentation/arch/aspects.yaml +81 -0
- package/documentation/arch/components/browser.yaml +51 -0
- package/documentation/arch/components/examples/context.yaml +37 -0
- package/documentation/arch/components/examples/order.yaml +92 -0
- package/documentation/arch/components/examples/payment.yaml +92 -0
- package/documentation/arch/components/examples/root.yaml +42 -0
- package/documentation/arch/components/front.yaml +309 -0
- package/documentation/arch/components/gitlab.yaml +81 -0
- package/documentation/arch/components/plantuml.yaml +57 -0
- package/documentation/arch/components/root.yaml +36 -0
- package/documentation/arch/components/user.yaml +41 -0
- package/documentation/arch/components/web.yaml +39 -0
- package/documentation/arch/contexts.yaml +99 -0
- package/documentation/arch/forms.yaml +36 -0
- package/documentation/arch/namespaces.yaml +43 -0
- package/documentation/arch/root.yaml +43 -0
- package/documentation/arch/rules.yaml +91 -0
- package/documentation/arch/technologies.yaml +84 -0
- package/documentation/dochub.yaml +32 -0
- package/documentation/docs/conception/archdistrib.puml +38 -0
- package/documentation/docs/conception/archeco.puml +11 -0
- package/documentation/docs/conception/archeco_proc.puml +29 -0
- package/documentation/docs/conception/archver.puml +24 -0
- package/documentation/docs/conception/facade.puml +20 -0
- package/documentation/docs/conception/introduction.md +144 -0
- package/documentation/docs/conception/mindmap.puml +55 -0
- package/documentation/docs/conception/root.yaml +66 -0
- package/documentation/docs/manual/aspects.md +37 -0
- package/documentation/docs/manual/backend/api.yaml +664 -0
- package/documentation/docs/manual/backend/search-implementation.md +190 -0
- package/documentation/docs/manual/backend/search.yaml +495 -0
- package/documentation/docs/manual/clickstream-setup.md +50 -0
- package/documentation/docs/manual/components.md +45 -0
- package/documentation/docs/manual/config/deployment.md +337 -0
- package/documentation/docs/manual/context_source.puml +17 -0
- package/documentation/docs/manual/contexts.md +200 -0
- package/documentation/docs/manual/datasets.md +120 -0
- package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
- package/documentation/docs/manual/docs/asyncapi.md +63 -0
- package/documentation/docs/manual/docs/bpmn.md +122 -0
- package/documentation/docs/manual/docs/charts.md +371 -0
- package/documentation/docs/manual/docs/docs.md +76 -0
- package/documentation/docs/manual/docs/drawio_intro.md +397 -0
- package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
- package/documentation/docs/manual/docs/editable_table/template.md +24 -0
- package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
- package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
- package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
- package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
- package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
- package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
- package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
- package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
- package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
- package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
- package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
- package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
- package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
- package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
- package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
- package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
- package/documentation/docs/manual/docs/examples/example.html +2 -0
- package/documentation/docs/manual/docs/examples/example.puml +17 -0
- package/documentation/docs/manual/docs/examples/example.yaml +53 -0
- package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
- package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
- package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
- package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
- package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
- package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
- package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
- package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
- package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
- package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
- package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
- package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
- package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
- package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
- package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
- package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
- package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
- package/documentation/docs/manual/docs/examples/table.yaml +341 -0
- package/documentation/docs/manual/docs/examples/template.puml +6 -0
- package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
- package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
- package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
- package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
- package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
- package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
- package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
- package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
- package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
- package/documentation/docs/manual/docs/gigachat/template.md +38 -0
- package/documentation/docs/manual/docs/images/cloud.png +0 -0
- package/documentation/docs/manual/docs/images/component.png +0 -0
- package/documentation/docs/manual/docs/images/system.png +0 -0
- package/documentation/docs/manual/docs/images/user.png +0 -0
- package/documentation/docs/manual/docs/markaper.md +278 -0
- package/documentation/docs/manual/docs/markdown.md +148 -0
- package/documentation/docs/manual/docs/mermaid.md +43 -0
- package/documentation/docs/manual/docs/network.md +117 -0
- package/documentation/docs/manual/docs/plantuml.md +28 -0
- package/documentation/docs/manual/docs/root.yaml +736 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
- package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
- package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
- package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
- package/documentation/docs/manual/docs/smartants.md +583 -0
- package/documentation/docs/manual/docs/svg_inline.md +66 -0
- package/documentation/docs/manual/docs/swagger.md +52 -0
- package/documentation/docs/manual/docs/tables.md +264 -0
- package/documentation/docs/manual/docs/templates/example.drawio +43 -0
- package/documentation/docs/manual/docs/templates/test.svg +79 -0
- package/documentation/docs/manual/docs/templates.md +361 -0
- package/documentation/docs/manual/docs/toc.md +137 -0
- package/documentation/docs/manual/entities/bstages.md +43 -0
- package/documentation/docs/manual/entities/bundle.md +105 -0
- package/documentation/docs/manual/entities/entities.md +727 -0
- package/documentation/docs/manual/entities/images/id_errors.png +0 -0
- package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
- package/documentation/docs/manual/entities/images/object_select.png +0 -0
- package/documentation/docs/manual/entities/images/problems.png +0 -0
- package/documentation/docs/manual/entities/images/select_inter.png +0 -0
- package/documentation/docs/manual/entities/images/stages.jpg +0 -0
- package/documentation/docs/manual/entities/images/suggests.png +0 -0
- package/documentation/docs/manual/entities/intro.md +73 -0
- package/documentation/docs/manual/entities/rules.md +35 -0
- package/documentation/docs/manual/functions/example.yaml +50 -0
- package/documentation/docs/manual/functions/functions.md +51 -0
- package/documentation/docs/manual/functions/root.yaml +39 -0
- package/documentation/docs/manual/images/jbps1.1.png +0 -0
- package/documentation/docs/manual/images/jbps1.png +0 -0
- package/documentation/docs/manual/images/jbps2.png +0 -0
- package/documentation/docs/manual/images/vsc1.png +0 -0
- package/documentation/docs/manual/imports.md +59 -0
- package/documentation/docs/manual/introduction.md +38 -0
- package/documentation/docs/manual/jsonata.md +268 -0
- package/documentation/docs/manual/plugin-settings.md +134 -0
- package/documentation/docs/manual/plugins/interface.md +226 -0
- package/documentation/docs/manual/plugins/introduction.md +256 -0
- package/documentation/docs/manual/plugins/root.yaml +51 -0
- package/documentation/docs/manual/role-model.md +80 -0
- package/documentation/docs/manual/root-cluster-import.md +82 -0
- package/documentation/docs/manual/root.yaml +199 -0
- package/documentation/docs/manual/rules/exceptions.md +20 -0
- package/documentation/docs/manual/rules/exreason.md +3 -0
- package/documentation/docs/manual/rules/root.yaml +58 -0
- package/documentation/docs/manual/rules/rules.md +8 -0
- package/documentation/docs/manual/rules/standard.md +3 -0
- package/documentation/docs/manual/rules/validators.md +109 -0
- package/documentation/docs/manual/technologies.md +49 -0
- package/documentation/docs/root.yaml +32 -0
- package/documentation/docs/sequence.puml +48 -0
- package/documentation/docs/welcome.md +3 -0
- package/documentation/entities/extentions/entity.yaml +136 -0
- package/documentation/entities/extentions/templates/people.md +4 -0
- package/documentation/entities/interactions/entity.yaml +412 -0
- package/documentation/entities/interactions/templates/blank.puml +18 -0
- package/documentation/entities/interactions/templates/bpmn.xml +59 -0
- package/documentation/entities/interactions/templates/tree.puml +11 -0
- package/documentation/entities/root.yaml +33 -0
- package/documentation/root.yaml +37 -0
- package/metamodel/dochub/entities/aspects/base.yaml +73 -0
- package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
- package/metamodel/dochub/entities/aspects/components.yaml +52 -0
- package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
- package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
- package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
- package/metamodel/dochub/entities/aspects/root.yaml +9 -0
- package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
- package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
- package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
- package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
- package/metamodel/dochub/entities/components/base.yaml +97 -0
- package/metamodel/dochub/entities/components/blank.yaml +64 -0
- package/metamodel/dochub/entities/components/contexts.yaml +55 -0
- package/metamodel/dochub/entities/components/docs.yaml +50 -0
- package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
- package/metamodel/dochub/entities/components/index.yaml +17 -0
- package/metamodel/dochub/entities/components/root.yaml +8 -0
- package/metamodel/dochub/entities/components/summary.yaml +58 -0
- package/metamodel/dochub/entities/components/symbol.yaml +113 -0
- package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/components/templates/summary.md +8 -0
- package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/components/tree.yaml +38 -0
- package/metamodel/dochub/entities/contexts/base.yaml +197 -0
- package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
- package/metamodel/dochub/entities/contexts/root.yaml +5 -0
- package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
- package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
- package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
- package/metamodel/dochub/entities/documents/base.yaml +73 -0
- package/metamodel/dochub/entities/documents/blank.yaml +28 -0
- package/metamodel/dochub/entities/documents/root.yaml +3 -0
- package/metamodel/dochub/entities/root.yaml +5 -0
- package/metamodel/dochub/functions/root.yaml +2 -0
- package/metamodel/dochub/functions/tools.yaml +46 -0
- package/metamodel/dochub/root.yaml +24 -0
- package/metamodel/dochub/rules/root.yaml +2 -0
- package/metamodel/dochub/rules/validators.yaml +144 -0
- package/metamodel/dochub/samples/01_components.yaml +23 -0
- package/metamodel/dochub/samples/02_contexts.yaml +23 -0
- package/metamodel/dochub/samples/03_documents.yaml +10 -0
- package/metamodel/dochub/samples/root.yaml +4 -0
- package/metamodel/dochub/samples/test.puml +17 -0
- package/metamodel/dochub.yaml +5 -0
- package/metamodel/docs/welcome.md +39 -0
- package/metamodel/root.yaml +8 -0
- package/package.json +29 -0
- package/plugin.html +1961 -0
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Ролевая модель и доступы на портале. Инструкция для администраторов
|
|
2
|
+
[[toc]]
|
|
3
|
+
## Назначение документа
|
|
4
|
+
|
|
5
|
+
Документ описывает, как на текущий момент работает доступ на портале и какие действия должен выполнить администратор, чтобы пользователь получил доступ к данным.
|
|
6
|
+
|
|
7
|
+
Функциональность ролей и альтернативных источников доступов будет расширена в будущих версиях.
|
|
8
|
+
|
|
9
|
+
## Как сейчас работает доступ
|
|
10
|
+
|
|
11
|
+
На текущий момент:
|
|
12
|
+
|
|
13
|
+
* роли, передаваемые из IdP, не используются;
|
|
14
|
+
* доступ пользователя определяется доступами в Bitbucket.
|
|
15
|
+
|
|
16
|
+
Если пользователь не видит данные на портале — причину следует искать в настройках доступа в Bitbucket.
|
|
17
|
+
|
|
18
|
+
## Источник прав доступа
|
|
19
|
+
|
|
20
|
+
### Bitbucket
|
|
21
|
+
|
|
22
|
+
Bitbucket является единственным источником прав доступа для портала.
|
|
23
|
+
|
|
24
|
+
Портал:
|
|
25
|
+
|
|
26
|
+
* использует данные о доступах пользователя к репозиториям Bitbucket;
|
|
27
|
+
* сопоставляет их с учетной записью пользователя из токена IdP.
|
|
28
|
+
|
|
29
|
+
Важно:
|
|
30
|
+
|
|
31
|
+
* учетная запись в Bitbucket должна совпадать с учетной записью, используемой для входа в портал (один и тот же IdP);
|
|
32
|
+
* если используются разные учетные записи — доступ на портале определен не будет.
|
|
33
|
+
|
|
34
|
+
## Поддерживаемые роли
|
|
35
|
+
|
|
36
|
+
На текущий момент портал не выполняет проверок ролей.
|
|
37
|
+
|
|
38
|
+
Роли, передаваемые из IdP:
|
|
39
|
+
|
|
40
|
+
* принимаются порталом;
|
|
41
|
+
* сохраняются в контексте пользователя;
|
|
42
|
+
* не участвуют в принятии решений о доступе.
|
|
43
|
+
|
|
44
|
+
Портал корректно работает с любыми ролями (включая пользовательские), переданными в токене IdP.
|
|
45
|
+
|
|
46
|
+
Фактический доступ пользователя определяется доступами в Bitbucket.
|
|
47
|
+
|
|
48
|
+
## Наделение пользователя доступом
|
|
49
|
+
|
|
50
|
+
### Предоставление доступа
|
|
51
|
+
|
|
52
|
+
Для того чтобы пользователь получил доступ к данным на портале, необходимо:
|
|
53
|
+
|
|
54
|
+
1. Определить репозиторий Bitbucket, соответствующий нужным данным.
|
|
55
|
+
2. Убедиться, что пользователь:
|
|
56
|
+
|
|
57
|
+
* существует в Bitbucket;
|
|
58
|
+
* использует ту же учетную запись / IdP, что и для входа в портал.
|
|
59
|
+
3. Выдать пользователю доступ к репозиторию Bitbucket:
|
|
60
|
+
|
|
61
|
+
* *Read* — для просмотра данных;
|
|
62
|
+
* более высокий уровень — для _будущих_ операций записи;
|
|
63
|
+
4. Дождаться применения изменений (происходит автоматически).
|
|
64
|
+
|
|
65
|
+
После этого пользователь сможет видеть соответствующие данные на портале.
|
|
66
|
+
|
|
67
|
+
### Отзыв доступа
|
|
68
|
+
|
|
69
|
+
Для отзыва доступа необходимо:
|
|
70
|
+
|
|
71
|
+
1. Удалить пользователя из списка участников репозитория Bitbucket или
|
|
72
|
+
2. Понизить уровень его прав.
|
|
73
|
+
|
|
74
|
+
Изменения вступят в силу автоматически.
|
|
75
|
+
|
|
76
|
+
## Развитие ролевой модели
|
|
77
|
+
|
|
78
|
+
В будущих версиях планируется использование ролей для ограничения доступа к разделам портала.
|
|
79
|
+
|
|
80
|
+
Данный документ описывает текущее состояние системы и будет обновляться по мере развития функциональности.
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Главный (root) манифест для кластера
|
|
2
|
+
|
|
3
|
+
Главное отличие от манифеста для backend режима в том как выглядит root манифест
|
|
4
|
+
|
|
5
|
+
## Root манифест
|
|
6
|
+
|
|
7
|
+
Раньше в нем было просто перечисление импортов различных манифестов, теперь он должен содержать список объектов с
|
|
8
|
+
правами
|
|
9
|
+
|
|
10
|
+
Было так:
|
|
11
|
+
|
|
12
|
+
```yaml
|
|
13
|
+
imports:
|
|
14
|
+
- ka_dzo_berezka/dochub.yaml
|
|
15
|
+
- ka_dzo_dub/dochub.yaml
|
|
16
|
+
- ka_dzo_osinka/dochub.yaml
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Стало так:
|
|
20
|
+
|
|
21
|
+
```yaml
|
|
22
|
+
imports:
|
|
23
|
+
- root: ka_dzo_berezka/root.yaml
|
|
24
|
+
permission: ecogroup.berezka
|
|
25
|
+
alias: berezka
|
|
26
|
+
warmupNeeded: true
|
|
27
|
+
title: ИП "Березка"
|
|
28
|
+
repos:
|
|
29
|
+
- type: kadzo
|
|
30
|
+
url: bitbucket:repo_ecogroup:pj_berezka
|
|
31
|
+
- root: ka_dzo_dub/root.yaml
|
|
32
|
+
permission: ecogroup.dub
|
|
33
|
+
alias: dub
|
|
34
|
+
name: ООО "Дубок"
|
|
35
|
+
repos:
|
|
36
|
+
- type: kadzo
|
|
37
|
+
url: bitbucket:repo_ecogroup:pj_dub
|
|
38
|
+
- root: ka_dzo_osinka/root.yaml
|
|
39
|
+
permission: ecogroup.osinka
|
|
40
|
+
alias: Осинка
|
|
41
|
+
repos:
|
|
42
|
+
- type: kadzo
|
|
43
|
+
url: bitbucket:repo_ecogroup:pj_osinka
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Импорты теперь это объект и он может содержать несколько атрибутов:
|
|
47
|
+
|
|
48
|
+
| Название | Обязательность | Дефолт | Описание |
|
|
49
|
+
|--------------|----------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
50
|
+
| root | Да | | Путь к файлу с импортом отдельной архитектуры |
|
|
51
|
+
| permission | Да | | Права, которые дают доступ к архитектуре из import (сравниваются с jwt) |
|
|
52
|
+
| alias | Да | | Название архитектуры, которое используется в запросах, например при перезагрузке |
|
|
53
|
+
| title | Нет | | Название архитектуры, которое будет отображаться в меню при выборе, какую архитектуру отображать (если не указан то будет использован alias) |
|
|
54
|
+
| warmupNeeded | Нет | false | true/false признак необходимости рассчитать datasets в момент загрузки архитектуры, а не при запросе пользователя |
|
|
55
|
+
| repos | Нет | | Массив данных для сохранения архитектур, указывается если необходимо выгружать разные типы архитектур инструментами |
|
|
56
|
+
| repos.type | Да | | Тип архитектуры (kadzo, оценки) |
|
|
57
|
+
| repos.url | Да | | Ссылка на git репозиторий используемый для сохранения указанного типа архитектуры в том же формате как и VUE_APP_DOCHUB_ROOT_DOCUMENT но без указания файла и ветки |
|
|
58
|
+
|
|
59
|
+
Если в настройках окружения ролевая модель выключена, но запущен режим кластера, то в root манифесте
|
|
60
|
+
допустимо указать только 1 объект архитектуры (один импорт). Т.к. ролевая модель выключена у всех будет доступ к нему.
|
|
61
|
+
|
|
62
|
+
#### Массив repos:
|
|
63
|
+
В релизе >=3.29 используется для отправки архитектуры через плагин. Сервис отправки будет запрашивать данные архитектуры у core сервиса и на основе отправленного
|
|
64
|
+
типа архитектуры будет искать подходящий repos.type в массиве repos. Далее архитектура будет сохранена по указанному (repos.url) git url
|
|
65
|
+
|
|
66
|
+
Сам массив не обязательный, но при наличии элементов они обязательно должны содержать атрибуты type и url
|
|
67
|
+
|
|
68
|
+
#### Перезагрузка
|
|
69
|
+
Для перезагрузки так же используется запрос PUT seaf-core/api/core/storage/reload описание которого можно найти на странице со swagger api (SEAF.ArchTool/Руководство/API SEAF.ArchTool)
|
|
70
|
+
|
|
71
|
+
#### Отображение одного манифеста за раз
|
|
72
|
+
Если система запущена в режиме кластера и включена ролевая модель, тогда активируется режим просмотра одного импорта (архитектуры).
|
|
73
|
+
Это значит, что на UI в меню появляется кнопка для выбора импорта в виде "Архитектура: {{ archName }}".
|
|
74
|
+
При нажатии на выбор импорта, пользователь будет видеть список доступных ему импортов (архитектур) и сможет переключаться между ними.
|
|
75
|
+
Выбранная архитектура привязана к вкладке (в разных вкладках можно открыть разные архитектуры). В Url проставляется параметр выбранной архитектуры, что позволяет ей делиться.
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
## Переменные окружения для управления ролевой моделью:
|
|
79
|
+
|
|
80
|
+
| Название | Дефолт | Описание |
|
|
81
|
+
|-------------------------------|--------|------------------------------------------------------------------------------------|
|
|
82
|
+
| VUE_APP_DOCHUB_ROLES_MODEL_V2 | N | Ролевая модель v2 основанная на правах в root манифесте Y - включено N - выключено |
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
# Copyright (C) 2021 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
# Copyright (C) 2024 Sber
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# In any derivative products, you must retain the information of
|
|
11
|
+
# owner of the original code and provide clear attribution to the project
|
|
12
|
+
#
|
|
13
|
+
# https://dochub.info
|
|
14
|
+
#
|
|
15
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
16
|
+
#
|
|
17
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
18
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
+
# See the License for the specific language governing permissions and
|
|
21
|
+
# limitations under the License.
|
|
22
|
+
#
|
|
23
|
+
# Maintainers:
|
|
24
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
25
|
+
#
|
|
26
|
+
# Contributors:
|
|
27
|
+
# R.Piontik <r.piontik@mail.ru> - 2021
|
|
28
|
+
# R.Piontik <r.piontik@mail.ru> - 2022
|
|
29
|
+
# R.Piontik <r.piontik@mail.ru> - 2023
|
|
30
|
+
# Nikolay Temnyakov, Sber - 2024
|
|
31
|
+
|
|
32
|
+
imports:
|
|
33
|
+
- docs/root.yaml
|
|
34
|
+
- rules/root.yaml
|
|
35
|
+
- plugins/root.yaml
|
|
36
|
+
- functions/root.yaml
|
|
37
|
+
docs:
|
|
38
|
+
archtool.manual:
|
|
39
|
+
location: SEAF.ArchTool/Руководство
|
|
40
|
+
description: Руководство
|
|
41
|
+
type: markdown
|
|
42
|
+
source: introduction.md
|
|
43
|
+
subjects:
|
|
44
|
+
- archtool
|
|
45
|
+
- archtool.front
|
|
46
|
+
archtool.imports:
|
|
47
|
+
location: SEAF.ArchTool/Руководство/Импорт
|
|
48
|
+
description: Импорт манифестов
|
|
49
|
+
type: markdown
|
|
50
|
+
subjects:
|
|
51
|
+
- archtool.front
|
|
52
|
+
- archtool.front.spa
|
|
53
|
+
source: imports.md
|
|
54
|
+
archtool.imports.root:
|
|
55
|
+
location: SEAF.ArchTool/Руководство/Импорт/Root манифест/Кластер
|
|
56
|
+
description: Root манифест в кластере
|
|
57
|
+
type: markdown
|
|
58
|
+
subjects:
|
|
59
|
+
- archtool.front
|
|
60
|
+
- archtool.front.spa
|
|
61
|
+
source: root-cluster-import.md
|
|
62
|
+
archtool.components:
|
|
63
|
+
location: SEAF.ArchTool/Руководство/Компоненты
|
|
64
|
+
description: Компоненты
|
|
65
|
+
type: markdown
|
|
66
|
+
subjects:
|
|
67
|
+
- archtool.front
|
|
68
|
+
- archtool.front.spa.blank
|
|
69
|
+
- archtool.front.spa.blank.component
|
|
70
|
+
source: components.md
|
|
71
|
+
archtool.contexts:
|
|
72
|
+
location: SEAF.ArchTool/Руководство/Контексты
|
|
73
|
+
description: Контексты
|
|
74
|
+
type: markdown
|
|
75
|
+
subjects:
|
|
76
|
+
- archtool.front
|
|
77
|
+
- archtool.front.spa
|
|
78
|
+
- archtool.front.spa.blank
|
|
79
|
+
- archtool.front.spa.blank.context
|
|
80
|
+
source: contexts.md
|
|
81
|
+
archtool.aspects:
|
|
82
|
+
location: SEAF.ArchTool/Руководство/Аспекты
|
|
83
|
+
description: Аспекты
|
|
84
|
+
type: markdown
|
|
85
|
+
subjects:
|
|
86
|
+
- archtool.front
|
|
87
|
+
- archtool.front.spa
|
|
88
|
+
- archtool.front.spa.blank
|
|
89
|
+
- archtool.front.spa.blank.aspect
|
|
90
|
+
source: aspects.md
|
|
91
|
+
archtool.technologies:
|
|
92
|
+
location: SEAF.ArchTool/Руководство/Технологии
|
|
93
|
+
description: Технологии
|
|
94
|
+
type: markdown
|
|
95
|
+
subjects:
|
|
96
|
+
- archtool.front
|
|
97
|
+
- archtool.front.spa
|
|
98
|
+
source: technologies.md
|
|
99
|
+
archtool.datasets:
|
|
100
|
+
location: SEAF.ArchTool/Руководство/Источники данных
|
|
101
|
+
description: Источники данных
|
|
102
|
+
type: markdown
|
|
103
|
+
source: datasets.md
|
|
104
|
+
subjects:
|
|
105
|
+
- archtool.front
|
|
106
|
+
- archtool.front.spa
|
|
107
|
+
- archtool.front.spa.dataset
|
|
108
|
+
archtool.jsonata:
|
|
109
|
+
location: SEAF.ArchTool/Руководство/JSONata+
|
|
110
|
+
description: Расширения JSONata
|
|
111
|
+
type: markdown
|
|
112
|
+
subjects:
|
|
113
|
+
- archtool.front
|
|
114
|
+
- archtool.front.spa
|
|
115
|
+
- archtool.front.spa.dataset
|
|
116
|
+
source: jsonata.md
|
|
117
|
+
archtool.clickstream:
|
|
118
|
+
location: SEAF.ArchTool/Руководство/Продуктовая аналитика с ClickStream
|
|
119
|
+
description: Продуктовая аналитика с ClickStream
|
|
120
|
+
type: markdown
|
|
121
|
+
source: clickstream-setup.md
|
|
122
|
+
archtool.role-model:
|
|
123
|
+
location: SEAF.ArchTool/Руководство/Ролевая модель
|
|
124
|
+
description: Инструкция для администраторов
|
|
125
|
+
type: markdown
|
|
126
|
+
source: role-model.md
|
|
127
|
+
archtool.plugin-settings:
|
|
128
|
+
location: SEAF.ArchTool/Руководство/Настройки плагина
|
|
129
|
+
description: Настройки плагина
|
|
130
|
+
type: markdown
|
|
131
|
+
source: plugin-settings.md
|
|
132
|
+
|
|
133
|
+
#**************************************************************
|
|
134
|
+
# Сущности
|
|
135
|
+
#**************************************************************
|
|
136
|
+
archtool.flex_metamodel:
|
|
137
|
+
location: SEAF.ArchTool/Руководство/Адаптивная метамодель
|
|
138
|
+
description: Адаптивная метамодель
|
|
139
|
+
type: markdown
|
|
140
|
+
subjects:
|
|
141
|
+
- archtool.front
|
|
142
|
+
- archtool.front.spa
|
|
143
|
+
source: entities/intro.md
|
|
144
|
+
archtool.flex_metamodel.entities:
|
|
145
|
+
location: SEAF.ArchTool/Руководство/Адаптивная метамодель/Entity
|
|
146
|
+
description: Сущность
|
|
147
|
+
type: markdown
|
|
148
|
+
subjects:
|
|
149
|
+
- archtool.front
|
|
150
|
+
- archtool.front.spa
|
|
151
|
+
source: entities/entities.md
|
|
152
|
+
archtool.flex_metamodel.bundle:
|
|
153
|
+
location: SEAF.ArchTool/Руководство/Адаптивная метамодель/Пакеты
|
|
154
|
+
description: Руководство пользователя
|
|
155
|
+
type: markdown
|
|
156
|
+
subjects:
|
|
157
|
+
- archtool.front
|
|
158
|
+
- archtool.front.spa
|
|
159
|
+
source: entities/bundle.md
|
|
160
|
+
archtool.deployment:
|
|
161
|
+
icon: settings
|
|
162
|
+
location: SEAF.ArchTool/Развертывание
|
|
163
|
+
description: Развертывание
|
|
164
|
+
type: markdown
|
|
165
|
+
subjects:
|
|
166
|
+
- archtool.front
|
|
167
|
+
source: config/deployment.md
|
|
168
|
+
archtool.rules:
|
|
169
|
+
location: SEAF.ArchTool/Руководство/Ролевая модель
|
|
170
|
+
description: Ролевая модель
|
|
171
|
+
type: markdown
|
|
172
|
+
source: entities/rules.md
|
|
173
|
+
archtool.context.source:
|
|
174
|
+
type: plantuml
|
|
175
|
+
source: context_source.puml
|
|
176
|
+
#**************************************************************
|
|
177
|
+
# Backend
|
|
178
|
+
#**************************************************************
|
|
179
|
+
archtool.backend:
|
|
180
|
+
location: SEAF.ArchTool/Руководство/API SEAF.ArchTool
|
|
181
|
+
description: API сервера SEAF.ArchTool
|
|
182
|
+
type: OpenAPI
|
|
183
|
+
subjects:
|
|
184
|
+
- archtool.backend
|
|
185
|
+
source: backend/api.yaml
|
|
186
|
+
archtool.backend.search:
|
|
187
|
+
location: SEAF.ArchTool/Руководство/Search API SEAF.ArchTool
|
|
188
|
+
description: Search API сервера SEAF.ArchTool
|
|
189
|
+
type: OpenAPI
|
|
190
|
+
subjects:
|
|
191
|
+
- archtool.backend
|
|
192
|
+
source: backend/search.yaml
|
|
193
|
+
archtool.backend.search.implementation:
|
|
194
|
+
location: SEAF.ArchTool/Руководство/Реализация поиска
|
|
195
|
+
description: Реализация поиска — backend, frontend, конфигурация
|
|
196
|
+
type: markdown
|
|
197
|
+
subjects:
|
|
198
|
+
- archtool.backend
|
|
199
|
+
source: backend/search-implementation.md
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Архитектурные исключения (exceptions)
|
|
2
|
+
|
|
3
|
+
Исключения непосредственно связаны с результатом работы архитектурных [валидаторов](/docs/archtool.rules.validators).
|
|
4
|
+
Они позволяют игнорировать некоторые выявленные ошибки, с указанием онования для этого.
|
|
5
|
+
|
|
6
|
+
Пример исключения:
|
|
7
|
+
```yaml
|
|
8
|
+
...
|
|
9
|
+
rules:
|
|
10
|
+
exceptions: # Исключения для валидаторов
|
|
11
|
+
"source-component-dochub.front.spa.blank.doc.markdown": # UID ошибки для исключения
|
|
12
|
+
reason: > # Причина исключения
|
|
13
|
+
Пример исключения для указания исходных кодов
|
|
14
|
+
cause: /docs/dochub.exceptions.examples.doc_markdown # Документ-основание исключения...
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
В примере создано исключение для валидатра "dochub.source".
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Copyright (C) 2022 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# In any derivative products, you must retain the information of
|
|
10
|
+
# owner of the original code and provide clear attribution to the project
|
|
11
|
+
#
|
|
12
|
+
# https://dochub.info
|
|
13
|
+
#
|
|
14
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
15
|
+
#
|
|
16
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
# See the License for the specific language governing permissions and
|
|
20
|
+
# limitations under the License.
|
|
21
|
+
#
|
|
22
|
+
# Maintainers:
|
|
23
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
24
|
+
#
|
|
25
|
+
# Contributors:
|
|
26
|
+
# R.Piontik <r.piontik@mail.ru> - 2022
|
|
27
|
+
# R.Piontik <r.piontik@mail.ru> - 2023
|
|
28
|
+
|
|
29
|
+
docs:
|
|
30
|
+
archtool.rules:
|
|
31
|
+
location: SEAF.ArchTool/Руководство/Правила
|
|
32
|
+
description: Подсистема контроля
|
|
33
|
+
type: markdown
|
|
34
|
+
source: rules.md
|
|
35
|
+
subjects:
|
|
36
|
+
- archtool
|
|
37
|
+
archtool.rules.validators:
|
|
38
|
+
location: SEAF.ArchTool/Руководство/Правила/Валидаторы
|
|
39
|
+
description: Валидаторы
|
|
40
|
+
type: markdown
|
|
41
|
+
source: validators.md
|
|
42
|
+
subjects:
|
|
43
|
+
- dochub
|
|
44
|
+
archtool.rules.exceptions:
|
|
45
|
+
location: SEAF.ArchTool/Руководство/Правила/Исключения
|
|
46
|
+
description: Исключения
|
|
47
|
+
type: markdown
|
|
48
|
+
source: exceptions.md
|
|
49
|
+
subjects:
|
|
50
|
+
- dochub
|
|
51
|
+
archtool.standards.examples.expert:
|
|
52
|
+
description: Пример стандарта
|
|
53
|
+
type: markdown
|
|
54
|
+
source: standard.md
|
|
55
|
+
archtool.exceptions.examples.doc_markdown:
|
|
56
|
+
description: Пример основания для исключения
|
|
57
|
+
type: markdown
|
|
58
|
+
source: exreason.md
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Архитектурные правила (rules)
|
|
2
|
+
|
|
3
|
+
Подсистема контроля включает в себя:
|
|
4
|
+
|
|
5
|
+
* [***Валидаторы***](/docs/archtool.rules.validators) - предназначены для проверки кода архитектуры на соответсвие правилам
|
|
6
|
+
* [***Исключения***](/docs/archtool.rules.exceptions) - дают возможность создать исключения из правил
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Архитектурные валидаторы (validators)
|
|
2
|
+
|
|
3
|
+
Валидаторы позволяют контролировать код архитектуры на консистеностность и достаточность. Предоставляют возможность
|
|
4
|
+
верифицировать ее с внешними источниками и контролировать архитектурные стандарты.
|
|
5
|
+
|
|
6
|
+
Каждый валидатор имеет свой уникальный, структурированный идентификатор. На основании идентификаторов строится
|
|
7
|
+
[дерево](/problems), которое наглядно определяет где обнаружена проблема.
|
|
8
|
+
|
|
9
|
+
## Простой валидатор
|
|
10
|
+
|
|
11
|
+
Пример описания простого валидатора:
|
|
12
|
+
```yaml
|
|
13
|
+
...
|
|
14
|
+
rules:
|
|
15
|
+
validators:
|
|
16
|
+
dochub.experts: # Валидатор контролирует заполнение поля expert для компонентов L1
|
|
17
|
+
title: Не указаны эксперты для компонентов # Название валидатора
|
|
18
|
+
source: > # Источник данных об ошибках. В данном случае JSONata запрос
|
|
19
|
+
([([
|
|
20
|
+
components.$spread().( /* Сканируем все компоненты */
|
|
21
|
+
$ID := $keys()[0];
|
|
22
|
+
{ /* Генерируем массив признаков проблем */
|
|
23
|
+
"isComponent": *.entity = "component", /* Это компонент */
|
|
24
|
+
"isDocHubL1Domain": $boolean($match($ID, /dochub\.[^\.]*$/)), /* в домене DocHub L1 */
|
|
25
|
+
"isExpertEmpty": $not($boolean("" & *.expert)), /* и поле expert не заполнено */
|
|
26
|
+
"id": $ID
|
|
27
|
+
}
|
|
28
|
+
)
|
|
29
|
+
][isDocHubL1Domain and isExpertEmpty and isComponent]).{ /* Отбираем все компоненты где поле 'expert' пустое*/
|
|
30
|
+
"uid": "expert-component-" & id, /* Уникальный идентификатор выявленной ошибки */
|
|
31
|
+
"location": "/architect/components/" & id, /* Ссылка на расположение объекта ошибки */
|
|
32
|
+
"correction": "Укажите эксперта по компоненту", /* Рекомендации как исправить проблему */
|
|
33
|
+
"description": "Компоненты L1 должены иметь сведения об экспертах."
|
|
34
|
+
}])
|
|
35
|
+
...
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
В поле 'source' можно указать идентификатор источника данных ['dataset'](/docs/archtool.datasets).
|
|
39
|
+
В целом, работа валидаторов с источниками аналогичная работе [таблиц](/docs/archtool.tables) с ними.
|
|
40
|
+
|
|
41
|
+
Результатом работы валидатора становится массив структур описывающих обнаруженные ошибки. Например:
|
|
42
|
+
|
|
43
|
+
```JSON
|
|
44
|
+
[
|
|
45
|
+
{
|
|
46
|
+
"uid": "expert-component-dochub.front",
|
|
47
|
+
"location": "/components/dochub.front",
|
|
48
|
+
"correction": "Укажите эксперта компонента",
|
|
49
|
+
"description": "Компоненты должены иметь сведения об эксперте.
|
|
50
|
+
Если необходимо исключить для данного компонента эту информацию,
|
|
51
|
+
укажите идентификатор ошибки в разделе 'exceptions' с описанием причины",
|
|
52
|
+
"cause": "dochub.standards.examples.expert"
|
|
53
|
+
}
|
|
54
|
+
]
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
* ***uid*** - Обязательное поле. Уникальный идентификатор ошибки. Важно обеспечить его глобальную уникальность.
|
|
58
|
+
* ***title*** - Опциональное поле. Определяет представление отклонения в дереве.
|
|
59
|
+
* ***location*** - Опциональное поле. URL с расположением объекта, где выявлена ошибка.
|
|
60
|
+
* ***correction*** - Опциональное поле. Краткое пояснение, как исправить ошибку.
|
|
61
|
+
* ***description*** - Опциональное поле. Описание причины ошибки.
|
|
62
|
+
* ***cause*** - Опциональное поле. Идентификатор или URL документа, на основании которого создан валидатор.
|
|
63
|
+
|
|
64
|
+
## Валидатор с использованием JSON Schema
|
|
65
|
+
|
|
66
|
+
Для контроля метамодели больше подходит специализированный словарь, который позволяет аннотировать и проверять
|
|
67
|
+
структуру данных архитектуры. В качестве такого словаря используется [JSON Schema](https://json-schema.org/),
|
|
68
|
+
реализованная NPM пакетом [avj](https://www.npmjs.com/package/ajv).
|
|
69
|
+
|
|
70
|
+
Пример описания отклонения:
|
|
71
|
+
```yaml
|
|
72
|
+
dochub.fields.source: # Валидатор контролирует заполнение поля указывающего на исходник для домена DocHub
|
|
73
|
+
# используя для этого JSON schema (https://json-schema.org/)
|
|
74
|
+
title: Не указан файл исходного кода # Название валидатора
|
|
75
|
+
schema: # JSON Schema
|
|
76
|
+
type: object
|
|
77
|
+
properties:
|
|
78
|
+
source:
|
|
79
|
+
type: string
|
|
80
|
+
required:
|
|
81
|
+
- source
|
|
82
|
+
additionalProperties: true
|
|
83
|
+
source: > # Источник данных об ошибках
|
|
84
|
+
(
|
|
85
|
+
/* Создаем валидатор JSON schema */
|
|
86
|
+
$validator := $jsonschema($self.schema); /* Схему валидата получаем из контекста отклонения*/
|
|
87
|
+
/* Формируем базу для проверки */
|
|
88
|
+
([([
|
|
89
|
+
components.$spread().( /* Сканируем все компоненты */
|
|
90
|
+
$ID := $keys()[0];
|
|
91
|
+
{ /* Генерируем массив признаков проблем */
|
|
92
|
+
"isComponent": *.entity = "component", /* Это компонент */
|
|
93
|
+
"isDocHubDomain": $boolean($match($ID, /dochub\.front.*/)), /* в домене DocHub */
|
|
94
|
+
"id": $ID, /* Запоминаем идентификатор компонента */
|
|
95
|
+
"isvalid": $validator($.*) /* Валидируем компонент по схеме */
|
|
96
|
+
}
|
|
97
|
+
)
|
|
98
|
+
][isDocHubDomain and isComponent and isvalid != true]).isvalid.{ /* Генерируем отклонения по выявленным нарушениям */
|
|
99
|
+
"uid": $.params.missingProperty & "-component-" & %.id, /* Уникальный идентификатор выявленной ошибки */
|
|
100
|
+
"location": "/architect/components/" & %.id, /* Ссылка на расположение объекта ошибки */
|
|
101
|
+
"correction": "Заполните необходимые поля", /* Рекомендации как исправить проблему */
|
|
102
|
+
"description": message
|
|
103
|
+
}])
|
|
104
|
+
)
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Результат работы валидатора аналогичен простому валидатору.
|
|
108
|
+
|
|
109
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Технологии (technologies)
|
|
2
|
+
|
|
3
|
+
Важным процессом в управлении архитектурой является управление технологическим стеком. SEAF.ArchTool позволяет решить
|
|
4
|
+
эту задачу через манифесты технологического стека. В манифесте перечисляются технологии и их статус.
|
|
5
|
+
|
|
6
|
+
```yaml
|
|
7
|
+
technologies: # Описание технологического стека
|
|
8
|
+
sections: # Определение разделов стека
|
|
9
|
+
language: # Идентификатор раздела
|
|
10
|
+
title: Языки программирования # Название раздела
|
|
11
|
+
parsers:
|
|
12
|
+
title: Парсеры
|
|
13
|
+
tools:
|
|
14
|
+
title: Инструментарий
|
|
15
|
+
storages:
|
|
16
|
+
title: Хранилища
|
|
17
|
+
browsers:
|
|
18
|
+
title: Браузеры
|
|
19
|
+
items: # Перечисление технологий
|
|
20
|
+
JavaScript: # Идентификатор технологии
|
|
21
|
+
aliases: # Синонимы технологии
|
|
22
|
+
- js
|
|
23
|
+
- NodeJS
|
|
24
|
+
title: Супер-крутой язык программирования # Название технологии
|
|
25
|
+
link: https://ru.wikipedia.org/wiki/JavaScript # Ссылка на документацию
|
|
26
|
+
section: language # Идентификатор секции технологии
|
|
27
|
+
status: adopt # Статус технологии adopt / trial / assess / hold
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
```yaml
|
|
31
|
+
title: Рабочая\nобласть
|
|
32
|
+
entity: component
|
|
33
|
+
source_file: src/components/Root.vue
|
|
34
|
+
technologies: # Используемые технологии
|
|
35
|
+
- JavaScript
|
|
36
|
+
- VUE3
|
|
37
|
+
links:
|
|
38
|
+
- id: archtool.router
|
|
39
|
+
title: Представление
|
|
40
|
+
direction: -->
|
|
41
|
+
- id: archtool.router
|
|
42
|
+
title: Параметры
|
|
43
|
+
direction: <--
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Описанные технологии также являются архитектурными объектами и имеют карточки.
|
|
47
|
+
Например, карточка для JavaScript:
|
|
48
|
+
|
|
49
|
+

|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Copyright (C) 2022 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# In any derivative products, you must retain the information of
|
|
10
|
+
# owner of the original code and provide clear attribution to the project
|
|
11
|
+
#
|
|
12
|
+
# https://dochub.info
|
|
13
|
+
#
|
|
14
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
15
|
+
#
|
|
16
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
# See the License for the specific language governing permissions and
|
|
20
|
+
# limitations under the License.
|
|
21
|
+
#
|
|
22
|
+
# Maintainers:
|
|
23
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
24
|
+
#
|
|
25
|
+
# Contributors:
|
|
26
|
+
# R.Piontik <r.piontik@mail.ru> - 2022
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
# Манифест описывающий сам DocHub
|
|
30
|
+
imports: # Подключение манифестов
|
|
31
|
+
- conception/root.yaml
|
|
32
|
+
- manual/root.yaml
|