@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc.1

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.
Files changed (298) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +27 -0
  3. package/documentation/arch/aspects.yaml +81 -0
  4. package/documentation/arch/components/browser.yaml +51 -0
  5. package/documentation/arch/components/examples/context.yaml +37 -0
  6. package/documentation/arch/components/examples/order.yaml +92 -0
  7. package/documentation/arch/components/examples/payment.yaml +92 -0
  8. package/documentation/arch/components/examples/root.yaml +42 -0
  9. package/documentation/arch/components/front.yaml +309 -0
  10. package/documentation/arch/components/gitlab.yaml +81 -0
  11. package/documentation/arch/components/plantuml.yaml +57 -0
  12. package/documentation/arch/components/root.yaml +36 -0
  13. package/documentation/arch/components/user.yaml +41 -0
  14. package/documentation/arch/components/web.yaml +39 -0
  15. package/documentation/arch/contexts.yaml +99 -0
  16. package/documentation/arch/forms.yaml +36 -0
  17. package/documentation/arch/namespaces.yaml +43 -0
  18. package/documentation/arch/root.yaml +43 -0
  19. package/documentation/arch/rules.yaml +91 -0
  20. package/documentation/arch/technologies.yaml +84 -0
  21. package/documentation/dochub.yaml +32 -0
  22. package/documentation/docs/conception/archdistrib.puml +38 -0
  23. package/documentation/docs/conception/archeco.puml +11 -0
  24. package/documentation/docs/conception/archeco_proc.puml +29 -0
  25. package/documentation/docs/conception/archver.puml +24 -0
  26. package/documentation/docs/conception/facade.puml +20 -0
  27. package/documentation/docs/conception/introduction.md +144 -0
  28. package/documentation/docs/conception/mindmap.puml +55 -0
  29. package/documentation/docs/conception/root.yaml +66 -0
  30. package/documentation/docs/manual/aspects.md +37 -0
  31. package/documentation/docs/manual/backend/api.yaml +664 -0
  32. package/documentation/docs/manual/backend/search-implementation.md +190 -0
  33. package/documentation/docs/manual/backend/search.yaml +495 -0
  34. package/documentation/docs/manual/clickstream-setup.md +50 -0
  35. package/documentation/docs/manual/components.md +45 -0
  36. package/documentation/docs/manual/config/deployment.md +337 -0
  37. package/documentation/docs/manual/context_source.puml +17 -0
  38. package/documentation/docs/manual/contexts.md +200 -0
  39. package/documentation/docs/manual/datasets.md +120 -0
  40. package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
  41. package/documentation/docs/manual/docs/asyncapi.md +63 -0
  42. package/documentation/docs/manual/docs/bpmn.md +122 -0
  43. package/documentation/docs/manual/docs/charts.md +371 -0
  44. package/documentation/docs/manual/docs/docs.md +76 -0
  45. package/documentation/docs/manual/docs/drawio_intro.md +397 -0
  46. package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
  47. package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
  48. package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
  49. package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
  50. package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
  51. package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
  52. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
  53. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
  54. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
  55. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
  56. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
  57. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
  58. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
  59. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
  60. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
  61. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
  62. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
  63. package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
  64. package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
  65. package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
  66. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
  67. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
  68. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
  69. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
  70. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
  71. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
  72. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
  73. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
  74. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
  75. package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
  76. package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
  77. package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
  78. package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
  79. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
  80. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
  81. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
  82. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
  83. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
  84. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
  85. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
  86. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
  87. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
  88. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
  89. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
  90. package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
  91. package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
  92. package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
  93. package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
  94. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
  95. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
  96. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
  97. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
  98. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
  99. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
  100. package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
  101. package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
  102. package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
  103. package/documentation/docs/manual/docs/editable_table/template.md +24 -0
  104. package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
  105. package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
  106. package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
  107. package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
  108. package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
  109. package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
  110. package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
  111. package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
  112. package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
  113. package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
  114. package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
  115. package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
  116. package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
  117. package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
  118. package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
  119. package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
  120. package/documentation/docs/manual/docs/examples/example.html +2 -0
  121. package/documentation/docs/manual/docs/examples/example.puml +17 -0
  122. package/documentation/docs/manual/docs/examples/example.yaml +53 -0
  123. package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
  124. package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
  125. package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
  126. package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
  127. package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
  128. package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
  129. package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
  130. package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
  131. package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
  132. package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
  133. package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
  134. package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
  135. package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
  136. package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
  137. package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
  138. package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
  139. package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
  140. package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
  141. package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
  142. package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
  143. package/documentation/docs/manual/docs/examples/table.yaml +341 -0
  144. package/documentation/docs/manual/docs/examples/template.puml +6 -0
  145. package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
  146. package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
  147. package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
  148. package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
  149. package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
  150. package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
  151. package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
  152. package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
  153. package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
  154. package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
  155. package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
  156. package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
  157. package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
  158. package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
  159. package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
  160. package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
  161. package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
  162. package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
  163. package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
  164. package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
  165. package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
  166. package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
  167. package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
  168. package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
  169. package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
  170. package/documentation/docs/manual/docs/gigachat/template.md +38 -0
  171. package/documentation/docs/manual/docs/images/cloud.png +0 -0
  172. package/documentation/docs/manual/docs/images/component.png +0 -0
  173. package/documentation/docs/manual/docs/images/system.png +0 -0
  174. package/documentation/docs/manual/docs/images/user.png +0 -0
  175. package/documentation/docs/manual/docs/markaper.md +278 -0
  176. package/documentation/docs/manual/docs/markdown.md +148 -0
  177. package/documentation/docs/manual/docs/mermaid.md +43 -0
  178. package/documentation/docs/manual/docs/network.md +117 -0
  179. package/documentation/docs/manual/docs/plantuml.md +28 -0
  180. package/documentation/docs/manual/docs/root.yaml +736 -0
  181. package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
  182. package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
  183. package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
  184. package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
  185. package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
  186. package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
  187. package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
  188. package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
  189. package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
  190. package/documentation/docs/manual/docs/smartants.md +583 -0
  191. package/documentation/docs/manual/docs/svg_inline.md +66 -0
  192. package/documentation/docs/manual/docs/swagger.md +52 -0
  193. package/documentation/docs/manual/docs/tables.md +264 -0
  194. package/documentation/docs/manual/docs/templates/example.drawio +43 -0
  195. package/documentation/docs/manual/docs/templates/test.svg +79 -0
  196. package/documentation/docs/manual/docs/templates.md +361 -0
  197. package/documentation/docs/manual/docs/toc.md +137 -0
  198. package/documentation/docs/manual/entities/bstages.md +43 -0
  199. package/documentation/docs/manual/entities/bundle.md +105 -0
  200. package/documentation/docs/manual/entities/entities.md +727 -0
  201. package/documentation/docs/manual/entities/images/id_errors.png +0 -0
  202. package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
  203. package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
  204. package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
  205. package/documentation/docs/manual/entities/images/object_select.png +0 -0
  206. package/documentation/docs/manual/entities/images/problems.png +0 -0
  207. package/documentation/docs/manual/entities/images/select_inter.png +0 -0
  208. package/documentation/docs/manual/entities/images/stages.jpg +0 -0
  209. package/documentation/docs/manual/entities/images/suggests.png +0 -0
  210. package/documentation/docs/manual/entities/intro.md +73 -0
  211. package/documentation/docs/manual/entities/rules.md +35 -0
  212. package/documentation/docs/manual/functions/example.yaml +50 -0
  213. package/documentation/docs/manual/functions/functions.md +51 -0
  214. package/documentation/docs/manual/functions/root.yaml +39 -0
  215. package/documentation/docs/manual/images/jbps1.1.png +0 -0
  216. package/documentation/docs/manual/images/jbps1.png +0 -0
  217. package/documentation/docs/manual/images/jbps2.png +0 -0
  218. package/documentation/docs/manual/images/vsc1.png +0 -0
  219. package/documentation/docs/manual/imports.md +59 -0
  220. package/documentation/docs/manual/introduction.md +38 -0
  221. package/documentation/docs/manual/jsonata.md +268 -0
  222. package/documentation/docs/manual/plugin-settings.md +134 -0
  223. package/documentation/docs/manual/plugins/interface.md +226 -0
  224. package/documentation/docs/manual/plugins/introduction.md +256 -0
  225. package/documentation/docs/manual/plugins/root.yaml +51 -0
  226. package/documentation/docs/manual/role-model.md +80 -0
  227. package/documentation/docs/manual/root-cluster-import.md +82 -0
  228. package/documentation/docs/manual/root.yaml +199 -0
  229. package/documentation/docs/manual/rules/exceptions.md +20 -0
  230. package/documentation/docs/manual/rules/exreason.md +3 -0
  231. package/documentation/docs/manual/rules/root.yaml +58 -0
  232. package/documentation/docs/manual/rules/rules.md +8 -0
  233. package/documentation/docs/manual/rules/standard.md +3 -0
  234. package/documentation/docs/manual/rules/validators.md +109 -0
  235. package/documentation/docs/manual/technologies.md +49 -0
  236. package/documentation/docs/root.yaml +32 -0
  237. package/documentation/docs/sequence.puml +48 -0
  238. package/documentation/docs/welcome.md +3 -0
  239. package/documentation/entities/extentions/entity.yaml +136 -0
  240. package/documentation/entities/extentions/templates/people.md +4 -0
  241. package/documentation/entities/interactions/entity.yaml +412 -0
  242. package/documentation/entities/interactions/templates/blank.puml +18 -0
  243. package/documentation/entities/interactions/templates/bpmn.xml +59 -0
  244. package/documentation/entities/interactions/templates/tree.puml +11 -0
  245. package/documentation/entities/root.yaml +33 -0
  246. package/documentation/root.yaml +37 -0
  247. package/metamodel/dochub/entities/aspects/base.yaml +73 -0
  248. package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
  249. package/metamodel/dochub/entities/aspects/components.yaml +52 -0
  250. package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
  251. package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
  252. package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
  253. package/metamodel/dochub/entities/aspects/root.yaml +9 -0
  254. package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
  255. package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
  256. package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
  257. package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
  258. package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
  259. package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
  260. package/metamodel/dochub/entities/components/base.yaml +97 -0
  261. package/metamodel/dochub/entities/components/blank.yaml +64 -0
  262. package/metamodel/dochub/entities/components/contexts.yaml +55 -0
  263. package/metamodel/dochub/entities/components/docs.yaml +50 -0
  264. package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
  265. package/metamodel/dochub/entities/components/index.yaml +17 -0
  266. package/metamodel/dochub/entities/components/root.yaml +8 -0
  267. package/metamodel/dochub/entities/components/summary.yaml +58 -0
  268. package/metamodel/dochub/entities/components/symbol.yaml +113 -0
  269. package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
  270. package/metamodel/dochub/entities/components/templates/summary.md +8 -0
  271. package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
  272. package/metamodel/dochub/entities/components/tree.yaml +38 -0
  273. package/metamodel/dochub/entities/contexts/base.yaml +197 -0
  274. package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
  275. package/metamodel/dochub/entities/contexts/root.yaml +5 -0
  276. package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
  277. package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
  278. package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
  279. package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
  280. package/metamodel/dochub/entities/documents/base.yaml +73 -0
  281. package/metamodel/dochub/entities/documents/blank.yaml +28 -0
  282. package/metamodel/dochub/entities/documents/root.yaml +3 -0
  283. package/metamodel/dochub/entities/root.yaml +5 -0
  284. package/metamodel/dochub/functions/root.yaml +2 -0
  285. package/metamodel/dochub/functions/tools.yaml +46 -0
  286. package/metamodel/dochub/root.yaml +24 -0
  287. package/metamodel/dochub/rules/root.yaml +2 -0
  288. package/metamodel/dochub/rules/validators.yaml +144 -0
  289. package/metamodel/dochub/samples/01_components.yaml +23 -0
  290. package/metamodel/dochub/samples/02_contexts.yaml +23 -0
  291. package/metamodel/dochub/samples/03_documents.yaml +10 -0
  292. package/metamodel/dochub/samples/root.yaml +4 -0
  293. package/metamodel/dochub/samples/test.puml +17 -0
  294. package/metamodel/dochub.yaml +5 -0
  295. package/metamodel/docs/welcome.md +39 -0
  296. package/metamodel/root.yaml +8 -0
  297. package/package.json +28 -0
  298. package/plugin.html +1963 -0
@@ -0,0 +1,664 @@
1
+ # Copyright (C) 2023 owner Roman Piontik R.Piontik@mail.ru
2
+ # Copyright (C) 2023 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> - 2023
28
+ # Vladislav Nefedov, Sber - 2023
29
+ # Nikolay Temnyakov, Sber - 2023
30
+
31
+ openapi: 3.0.3
32
+ info:
33
+ version: 1.0.0
34
+ title: SEAF.ArchTool API
35
+ description: >
36
+ Данный документ актуален для развертывания в режимах Client-Server и Cluster.
37
+ Здесь предоставляются интеграционные API, которые вы можете использовать для
38
+ встраивания SEAF.ArchTool в свои производственные процессы.
39
+ Подробнее тут https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/docs/manual/config/deployment.md
40
+ servers:
41
+ - url: https://{URL}
42
+ description: API server secure
43
+ variables:
44
+ URL:
45
+ default: localhost:3030
46
+ description: Сервер https для запроса
47
+ - url: http://{URL}
48
+ description: API server insecure
49
+ variables:
50
+ URL:
51
+ default: localhost:3030
52
+ description: Сервер http для запроса
53
+ tags:
54
+ - name: DataLake
55
+ description: "API для доступа в озеро данных архитектуры"
56
+ - name: Entities
57
+ description: "API взаимодействия с сущностями"
58
+ externalDocs:
59
+ url: "https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/docs/manual/entities/entities.md"
60
+ - name: DebugInfo
61
+ description: "API для получения дебаг-информации"
62
+ - name: UserInfo
63
+ description: "API для получения информации о пользователе"
64
+ - name: Logout
65
+ description: "API для выхода пользователя из системы"
66
+ - name: HealthInfo
67
+ description: "API для получения расширенной служебной информации о состоянии портала. ⚠️ Данный метод доступен только при работе SEAF.ArchTool в кластерном режиме."
68
+ paths:
69
+ /seaf-core/api/core/storage/jsonata/{query}:
70
+ get:
71
+ tags:
72
+ - DataLake
73
+ summary: Выполняет произвольный запрос JSONata к данным архитектуры
74
+ parameters:
75
+ - in: path
76
+ name: query
77
+ description: JSONata запрос в скобках "([запрос])" или идентификатор DataSet без скобок
78
+ required: true
79
+ schema:
80
+ $ref: '#/components/schemas/JSONataQuery'
81
+ example: >
82
+ ({"id": $params.id, "limit": $params.limit, "type": $self.type, "template": $self.template})
83
+ - in: query
84
+ name: params
85
+ description: >
86
+ JSON структура с параметрами передающаяся в запрос.
87
+ Будет доступна в переменной $params.
88
+ required: false
89
+ schema:
90
+ $ref: '#/components/schemas/JSONataParams'
91
+ example: '{"id":"sber.rdwsoft","limit":8}'
92
+ - in: query
93
+ name: subject
94
+ description: >
95
+ JSON структура с профилем объекта, который выполняет запрос.
96
+ Будет доступна в переменной $self.
97
+ required: false
98
+ schema:
99
+ $ref: '#/components/schemas/JSONataParams'
100
+ example: '{"type":"markdown","template":"template.md"}'
101
+ responses:
102
+ "200":
103
+ description: "Результат выполнения запроса"
104
+ content:
105
+ application/json:
106
+ schema:
107
+ $ref: '#/components/schemas/JSONataResult'
108
+ /seaf-core/api/core/storage/reload:
109
+ put:
110
+ tags:
111
+ - DataLake
112
+ summary: Перезагрузка манифестов в кластере
113
+ description: |
114
+ **В режиме backend**:
115
+ - перезагружает манифест, дополнительные параметры не нужны и не учитываются в обработке, необходимо передать только secret
116
+
117
+ **В режиме cluster**:
118
+ - работает по указанным ниже параметрам. Умеет:
119
+ - перезагружать выбранные манифесты
120
+ - перезагружать все манифесты
121
+ - обнаруживать ссылки на новые манифесты в root манифесте
122
+ Перезагружает указанные манифесты или все манифесты в кластере.
123
+ Может использоваться для принудительного обновления кэша.
124
+
125
+ В случае возникновения ошибки, можно поискать в логах по значению 'trace-id-123' из ответа с ошибкой
126
+ operationId: reloadClusterStorage
127
+ parameters:
128
+ - name: secret
129
+ in: query
130
+ description: secret для доступа к запросу. Указывается в .env переменной VUE_APP_DOCHUB_RELOAD_SECRET
131
+ required: true
132
+ schema:
133
+ type: string
134
+ example: "your-reload-secret-key"
135
+
136
+ - name: reloadRoot
137
+ in: query
138
+ description: |
139
+ Если true - запускает перезагрузку манифестов для подтягивания изменений из root манифеста.
140
+ Перезагрузка может запуститься если ранее она уже была запрошена (другим запросом) и не успела обработаться
141
+ При этом параметры alias и mode игнорируются если переданы.
142
+ schema:
143
+ type: string
144
+ enum: ["true", "false"]
145
+ default: "false"
146
+ example: "false"
147
+
148
+ - name: mode
149
+ in: query
150
+ description: |
151
+ Режим работы с параметром alias.
152
+ - `alias` (по умолчанию) - alias трактуются как имена манифестов
153
+ - `permission` - alias трактуются как разрешения, которые конвертируются в имена манифестов через root manifest
154
+ schema:
155
+ type: string
156
+ enum: [alias, permission]
157
+ default: alias
158
+ example: "alias"
159
+
160
+ - name: alias
161
+ in: query
162
+ description: |
163
+ Имена манифестов для перезагрузки.
164
+
165
+ **Формат передачи:**
166
+ - Для одного значения: `?alias=manifest1`
167
+ - Для нескольких значений: `?alias=manifest1&alias=manifest2&alias=manifest3`
168
+
169
+ Если параметр не указан - перезагружаются все доступные манифесты.
170
+
171
+ **Важно:** При `mode=permission` этот параметр содержит имена разрешений,
172
+ а не имена манифестов.
173
+
174
+ **Формат при `mode=permission` не отличается, но в alias ожидаются значения permission :**
175
+ - Для одного значения: `?alias=permission1`
176
+ - Для нескольких значений: `?alias=permission1&alias=permission2&alias=permission3`
177
+ style: form
178
+ explode: true
179
+ schema:
180
+ type: array
181
+ items:
182
+ type: string
183
+ example: ["manifest1"]
184
+
185
+ responses:
186
+ '200':
187
+ description: Запрос успешно обработан
188
+ content:
189
+ application/json:
190
+ schema:
191
+ type: object
192
+ properties:
193
+ message:
194
+ type: string
195
+ example: "success"
196
+ example: {
197
+ "message": "success"
198
+ }
199
+
200
+ '400':
201
+ description: |
202
+ Неверные параметры запроса
203
+ В режиме backend если что-то пошло не так, тоже возвращается 400
204
+ content:
205
+ application/json:
206
+ schema:
207
+ type: object
208
+ properties:
209
+ error:
210
+ type: string
211
+ example: "trace-id-123: bad params 'alias' (nir)"
212
+
213
+ '403':
214
+ description: Неверный секретный ключ
215
+ content:
216
+ application/json:
217
+ schema:
218
+ type: object
219
+ properties:
220
+ error:
221
+ type: string
222
+ example: "trace-id-123: Error reload secret is not valid [wrong-secret]"
223
+
224
+ '500':
225
+ description: Внутренняя ошибка сервера или сервер не готов
226
+ headers:
227
+ Retry-After:
228
+ description: Время в секундах, через которое можно повторить запрос
229
+ schema:
230
+ type: string
231
+ example: "60"
232
+ content:
233
+ application/json:
234
+ schema:
235
+ type: object
236
+ properties:
237
+ error:
238
+ type: string
239
+ example: "trace-id-123: server not ready (aliases empty in storage)"
240
+ /seaf-core/api/core/storage/release-data-profile/{path}:
241
+ get:
242
+ tags:
243
+ - DataLake
244
+ summary: >
245
+ По указанному пути возвращает результат реализации профиля данных.
246
+ Подробнее здесь - https://gitverse.ru/seafteam/seaf-archtool-core/content/master/public/documentation/docs/manual/datasets.md
247
+ parameters:
248
+ - in: path
249
+ name: path
250
+ description: Путь к профилю данных
251
+ required: true
252
+ schema:
253
+ $ref: '#/components/schemas/PathToDataProfile'
254
+ example: "/entities/interactions/presentations/blank"
255
+ - in: query
256
+ name: params
257
+ description: >
258
+ JSON структура с параметрами передающаяся в запрос.
259
+ Будет доступна в переменной $params.
260
+ required: false
261
+ schema:
262
+ $ref: '#/components/schemas/JSONataParams'
263
+ example: '{"id":"archtool.user"}'
264
+ responses:
265
+ "200":
266
+ description: "Результат выполнения запроса"
267
+ content:
268
+ application/json:
269
+ schema:
270
+ $ref: '#/components/schemas/JSONataResult'
271
+ /seaf-core/api/core/storage/problems:
272
+ get:
273
+ tags:
274
+ - DataLake
275
+ summary: Возвращает перечень обнаруженных проблем
276
+ responses:
277
+ "200":
278
+ description: "Массив обнаруженных проблем"
279
+ content:
280
+ application/json:
281
+ schema:
282
+ $ref: '#/components/schemas/ProblemsResult'
283
+ /seaf-core/api/core/storage/put-content/{hash}:
284
+ post:
285
+ tags:
286
+ - DataLake
287
+ summary: Сохраняет данные в Bitbucket
288
+ parameters:
289
+ - in: path
290
+ name: hash
291
+ description: Хеш пути к сущности
292
+ required: true
293
+ schema:
294
+ type: string
295
+ example: 8743b52063cd84097a65d1633f5c74f5
296
+ requestBody:
297
+ required: true
298
+ content:
299
+ application/json:
300
+ schema:
301
+ type: object
302
+ additionalProperties:
303
+ type: string
304
+ description: В теле запроса передается произвольное количество пар ключ-значение, где ключ - путь к сущности, значение - контент в формате JSON строки
305
+ example:
306
+ file-name.yaml: "updated content is very beautiful"
307
+ file-name2.yaml: "updated content is very beautiful here too"
308
+ responses:
309
+ "200":
310
+ description: "Данные обновлены успешно"
311
+ content:
312
+ application/json:
313
+ schema:
314
+ type: object
315
+ properties:
316
+ message:
317
+ type: string
318
+ example: "Created"
319
+ "404":
320
+ description: "В конфигурации указана СКВ отличная от Bitbucket"
321
+ content:
322
+ application/json:
323
+ schema:
324
+ type: object
325
+ properties:
326
+ errorMessage:
327
+ type: string
328
+ example: "Данное API поддерживает только Bitbucket Open API"
329
+ "400":
330
+ description: "Получено пустое тело запроса"
331
+ content:
332
+ application/json:
333
+ schema:
334
+ type: object
335
+ properties:
336
+ errorMessage:
337
+ type: string
338
+ example: "Отсутствует тело запроса"
339
+ "500":
340
+ description: "Внутренняя ошибка сервера. Данная ошибка возникает если не удалось извлечь тело запроса или Bitbucket вернул ошибку"
341
+ content:
342
+ application/json:
343
+ schema:
344
+ type: object
345
+ properties:
346
+ errorMessage:
347
+ type: string
348
+ example: "Получено пустое тело запроса"
349
+ /seaf-core/api/entities/{entity}/presentations/{presentation}:
350
+ get:
351
+ tags:
352
+ - Entities
353
+ summary: Вызывает специальную (upload) презентацию сущности
354
+ parameters:
355
+ - in: path
356
+ name: entity
357
+ description: Идентификатор сущности
358
+ required: true
359
+ schema:
360
+ $ref: '#/components/schemas/EntityID'
361
+ example: interactions
362
+ - in: path
363
+ name: presentation
364
+ description: Идентификатор презентации
365
+ required: true
366
+ schema:
367
+ $ref: '#/components/schemas/PresentationID'
368
+ example: export
369
+ - in: query
370
+ name: id
371
+ required: true
372
+ description: >
373
+ Параметр передающийся в презентацию. Зависит от самой презентации.
374
+ Будет доступен в презентации в $params.
375
+ schema:
376
+ $ref: '#/components/schemas/EntityParam'
377
+ example: archtool.user
378
+ responses:
379
+ "200":
380
+ description: "Презентация сущности"
381
+ content:
382
+ application/xml:
383
+ schema:
384
+ $ref: '#/components/schemas/ProblemsResult'
385
+ /seaf-core/api/core/storage/versions:
386
+ get:
387
+ tags:
388
+ - DebugInfo
389
+ summary: Получает информацию об используемых версиях ядра/плагина, метамодели, архитектуры
390
+ responses:
391
+ '200':
392
+ description: Успешный ответ с данными об используемых версиях
393
+ content:
394
+ application/json:
395
+ schema:
396
+ type: object
397
+ properties:
398
+ coreVersion:
399
+ type: string
400
+ example: "3.18.0"
401
+ nullable: true
402
+ archHash:
403
+ type: string
404
+ example: "abc123..."
405
+ metamodels:
406
+ type: object
407
+ required:
408
+ - dochub
409
+ properties:
410
+ dochub:
411
+ type: string
412
+ example: "4.1.0"
413
+ dochub-doc:
414
+ type: string
415
+ example: "3.1.0"
416
+ rootManifest:
417
+ type: string
418
+ example: "seaf.yaml"
419
+ enableChecker:
420
+ type: boolean
421
+ example: "true"
422
+ description: Признак для ui, что надо делать периодическую проверку версии на бэке (можно отключить проверку в env бэка VUE_APP_VERSION_CHECKER_ENABLE=y/n)
423
+ /seaf-core/api/core/user-info:
424
+ get:
425
+ tags:
426
+ - UserInfo
427
+ summary: Получает информацию о текущем пользователе
428
+ description: Данные о пользователе получаются из IdP токена
429
+ security:
430
+ - idpAuth: [ ]
431
+ responses:
432
+ "200":
433
+ description: Успешный ответ с данными пользователя
434
+ content:
435
+ application/json:
436
+ schema:
437
+ type: object
438
+ properties:
439
+ surname:
440
+ type: string
441
+ example: Иванов
442
+ name:
443
+ type: string
444
+ example: Иван
445
+ roles:
446
+ type: array
447
+ items:
448
+ type: object
449
+ properties:
450
+ role:
451
+ type: string
452
+ example: ADMIN
453
+ label:
454
+ type: string
455
+ example: Администратор
456
+ initials:
457
+ type: string
458
+ example: ИИ
459
+ userId:
460
+ type: string
461
+ example: 11879000
462
+ /seaf-core/api/core/user/rights:
463
+ get:
464
+ tags:
465
+ - UserInfo
466
+ summary: Получает информацию о правах текущего пользователя
467
+ description: Данные о пользователе получаются из jwt и данных root манифеста
468
+ responses:
469
+ "200":
470
+ description: Успешный ответ с правами
471
+ content:
472
+ application/json:
473
+ schema:
474
+ type: array
475
+ description: Массив с правами пользователя
476
+ items:
477
+ type: object
478
+ properties:
479
+ permission:
480
+ type: string
481
+ example: berezka:permission
482
+ alias:
483
+ type: string
484
+ example: berezka
485
+ ra:
486
+ type: string
487
+ example: repo_read
488
+ title:
489
+ type: string
490
+ example: ООО "Березка"
491
+ /health/info:
492
+ get:
493
+ tags:
494
+ - HealthInfo
495
+ summary: Возвращает детализированные служебные сведения о состоянии портала
496
+ responses:
497
+ "200":
498
+ description: Успешный ответ с данными
499
+ content:
500
+ application/json:
501
+ schema:
502
+ type: object
503
+ properties:
504
+ self:
505
+ type: object
506
+ properties:
507
+ processId:
508
+ type: string
509
+ example: "39d44ba8@DESKTOP-50PMHNV"
510
+ status:
511
+ type: string
512
+ example: "ready"
513
+ uptime:
514
+ type: string
515
+ example: "0h 0m 48s"
516
+ version:
517
+ type: string
518
+ example: "3.23.0"
519
+ master:
520
+ type: object
521
+ properties:
522
+ processId:
523
+ type: string
524
+ example: "56319e7c@DESKTOP-50PMHNV"
525
+ status:
526
+ type: string
527
+ example: "ready"
528
+ uptime:
529
+ type: string
530
+ example: "0h 11m 7s"
531
+ version:
532
+ type: string
533
+ example: "3.23.0"
534
+ manifests:
535
+ type: array
536
+ items:
537
+ type: object
538
+ properties:
539
+ successLoadTimestamp:
540
+ type: number
541
+ example: 1764251021849
542
+ domain:
543
+ type: string
544
+ example: "bitbucket:project:repo_1"
545
+ manifestHash:
546
+ type: string
547
+ example: "26a8d9a12bb794fc2db3bfc7a4394d03"
548
+ datasetHash:
549
+ type: string
550
+ example: "b9e1dabf038c933137778d90023986a2"
551
+ successLoadTimestampISO:
552
+ type: string
553
+ format: date-time
554
+ example: "2025-11-27T13:43:41.849Z"
555
+ "500":
556
+ description: "Ошибка на стороне сервера"
557
+ content:
558
+ application/json:
559
+ schema:
560
+ type: object
561
+ properties:
562
+ message:
563
+ type: string
564
+ example: "Ошибка при чтении манифеста"
565
+ "503":
566
+ description: "Сервис временно недоступен"
567
+ content:
568
+ application/json:
569
+ schema:
570
+ type: object
571
+ properties:
572
+ message:
573
+ type: string
574
+ example: "Манифест не инициализирован"
575
+ components:
576
+ schemas:
577
+ JSONataQuery:
578
+ type: string
579
+ pattern: '^([a-zA-Z\_]*(\.[a-zA-Z\_][a-zA-Z\_]*)*)|(\(.*\))$'
580
+ JSONataParams:
581
+ type: string
582
+ JSONataResult:
583
+ type: object
584
+ PathToDataProfile:
585
+ type: string
586
+ pattern: '^\/[a-zA-Z][a-zA-Z\_0-9]*(\/[a-zA-Z][a-zA-Z\_0-9]*)*$'
587
+ EntityID:
588
+ type: string
589
+ pattern: '^[a-zA-Z][a-zA-Z\_0-9]*$'
590
+ PresentationID:
591
+ type: string
592
+ pattern: '^[a-zA-Z][a-zA-Z\_0-9]*$'
593
+ EntityParam:
594
+ type: string
595
+ ProblemsResult:
596
+ type: object
597
+ properties:
598
+ process:
599
+ type: object
600
+ properties:
601
+ startEvent:
602
+ type: object
603
+ title: Просмотр архитектуры
604
+ properties:
605
+ outgoing:
606
+ type: string
607
+ required:
608
+ - outgoing
609
+ task:
610
+ type: array
611
+ title: Вход на портал
612
+ items:
613
+ - type: object
614
+ properties:
615
+ incoming:
616
+ type: string
617
+ outgoing:
618
+ type: string
619
+ required:
620
+ - incoming
621
+ - outgoing
622
+ - type: object
623
+ properties:
624
+ incoming:
625
+ type: string
626
+ outgoing:
627
+ type: string
628
+ required:
629
+ - incoming
630
+ - outgoing
631
+ sequenceFlow:
632
+ type: array
633
+ items:
634
+ - type: string
635
+ exclusiveGateway:
636
+ type: object
637
+ title: Информация о существующей архитектуре
638
+ properties:
639
+ incoming:
640
+ type: string
641
+ required:
642
+ - incoming
643
+ required:
644
+ - startEvent
645
+ - task
646
+ - sequenceFlow
647
+ - exclusiveGateway
648
+ required:
649
+ - process
650
+ LogoutUrl:
651
+ type: string
652
+ description: Сформированный logout URL. В случае ошибки конфигурации провайдера не возвращается
653
+ example: http://domainexample.ru/openid-connect-auth/logout?revoke=true&logout_idp=false
654
+ nullable: true
655
+ LogoutUrlError:
656
+ type: string
657
+ description: Сообщение об ошибке формирования logout URL
658
+ example: '2025-06-05T05:58:26.604Z: [ERROR] Unknown OIDC issuer "https://iss.example". No logout configuration found'
659
+ nullable: true
660
+ SecuritySchemes:
661
+ idpAuth:
662
+ type: http
663
+ scheme: bearer
664
+ bearerFormat: JWT