@documentation-robotics/cli 0.1.0 → 0.1.5

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 (510) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +466 -693
  3. package/dist/analysis/data-model-analyzer.js +189 -0
  4. package/dist/analysis/data-model-analyzer.js.map +7 -0
  5. package/dist/analysis/index.js +3 -0
  6. package/dist/analysis/index.js.map +7 -0
  7. package/dist/analysis/relationship-classifier.js +181 -0
  8. package/dist/analysis/relationship-classifier.js.map +7 -0
  9. package/dist/analyzers/base-analyzer.js +1 -0
  10. package/dist/analyzers/base-analyzer.js.map +7 -0
  11. package/dist/analyzers/call-graph-utils.js +39 -0
  12. package/dist/analyzers/call-graph-utils.js.map +7 -0
  13. package/dist/analyzers/cbm-analyzer.js +1205 -0
  14. package/dist/analyzers/cbm-analyzer.js.map +7 -0
  15. package/dist/analyzers/heuristic-utils.js +55 -0
  16. package/dist/analyzers/heuristic-utils.js.map +7 -0
  17. package/dist/analyzers/mapping-loader.js +146 -0
  18. package/dist/analyzers/mapping-loader.js.map +7 -0
  19. package/dist/analyzers/registry.js +124 -0
  20. package/dist/analyzers/registry.js.map +7 -0
  21. package/dist/analyzers/session-state.js +176 -0
  22. package/dist/analyzers/session-state.js.map +7 -0
  23. package/dist/analyzers/stdio-client.js +206 -0
  24. package/dist/analyzers/stdio-client.js.map +7 -0
  25. package/dist/analyzers/types.js +15 -0
  26. package/dist/analyzers/types.js.map +7 -0
  27. package/dist/analyzers/verify-engine.js +209 -0
  28. package/dist/analyzers/verify-engine.js.map +7 -0
  29. package/dist/analyzers/verify-ignore.js +130 -0
  30. package/dist/analyzers/verify-ignore.js.map +7 -0
  31. package/dist/analyzers/version.js +8 -0
  32. package/dist/analyzers/version.js.map +7 -0
  33. package/dist/audit/ai/runner.js +41 -0
  34. package/dist/audit/ai/runner.js.map +7 -0
  35. package/dist/audit/differential-analyzer.js +183 -0
  36. package/dist/audit/differential-analyzer.js.map +7 -0
  37. package/dist/audit/index.js +32 -0
  38. package/dist/audit/index.js.map +7 -0
  39. package/dist/audit/nodes/ai/evaluator.js +49 -0
  40. package/dist/audit/nodes/ai/evaluator.js.map +7 -0
  41. package/dist/audit/nodes/ai/parser.js +55 -0
  42. package/dist/audit/nodes/ai/parser.js.map +7 -0
  43. package/dist/audit/nodes/ai/prompts.js +103 -0
  44. package/dist/audit/nodes/ai/prompts.js.map +7 -0
  45. package/dist/audit/nodes/analysis/node-completeness-checker.js +32 -0
  46. package/dist/audit/nodes/analysis/node-completeness-checker.js.map +7 -0
  47. package/dist/audit/nodes/analysis/node-definition-analyzer.js +47 -0
  48. package/dist/audit/nodes/analysis/node-definition-analyzer.js.map +7 -0
  49. package/dist/audit/nodes/analysis/node-overlap-detector.js +79 -0
  50. package/dist/audit/nodes/analysis/node-overlap-detector.js.map +7 -0
  51. package/dist/audit/nodes/model/orchestrator.js +82 -0
  52. package/dist/audit/nodes/model/orchestrator.js.map +7 -0
  53. package/dist/audit/nodes/spec/loader.js +116 -0
  54. package/dist/audit/nodes/spec/loader.js.map +7 -0
  55. package/dist/audit/nodes/spec/orchestrator.js +68 -0
  56. package/dist/audit/nodes/spec/orchestrator.js.map +7 -0
  57. package/dist/audit/nodes/types.js +1 -0
  58. package/dist/audit/nodes/types.js.map +7 -0
  59. package/dist/audit/pipeline/index.js +5 -0
  60. package/dist/audit/pipeline/index.js.map +7 -0
  61. package/dist/audit/pipeline/pipeline-orchestrator.js +218 -0
  62. package/dist/audit/pipeline/pipeline-orchestrator.js.map +7 -0
  63. package/dist/audit/relationships/ai/evaluator.js +235 -0
  64. package/dist/audit/relationships/ai/evaluator.js.map +7 -0
  65. package/dist/audit/relationships/ai/parser.js +197 -0
  66. package/dist/audit/relationships/ai/parser.js.map +7 -0
  67. package/dist/audit/relationships/ai/prompts.js +274 -0
  68. package/dist/audit/relationships/ai/prompts.js.map +7 -0
  69. package/dist/audit/relationships/analysis/balance-assessor.js +115 -0
  70. package/dist/audit/relationships/analysis/balance-assessor.js.map +7 -0
  71. package/dist/audit/relationships/analysis/coverage-analyzer.js +99 -0
  72. package/dist/audit/relationships/analysis/coverage-analyzer.js.map +7 -0
  73. package/dist/audit/relationships/analysis/duplicate-detector.js +95 -0
  74. package/dist/audit/relationships/analysis/duplicate-detector.js.map +7 -0
  75. package/dist/audit/relationships/analysis/gap-analyzer.js +99 -0
  76. package/dist/audit/relationships/analysis/gap-analyzer.js.map +7 -0
  77. package/dist/audit/relationships/analysis/layer-templates.js +294 -0
  78. package/dist/audit/relationships/analysis/layer-templates.js.map +7 -0
  79. package/dist/audit/relationships/graph/connectivity.js +129 -0
  80. package/dist/audit/relationships/graph/connectivity.js.map +7 -0
  81. package/dist/audit/relationships/graph/relationship-graph.js +179 -0
  82. package/dist/audit/relationships/graph/relationship-graph.js.map +7 -0
  83. package/dist/audit/relationships/model/balance-assessor.js +49 -0
  84. package/dist/audit/relationships/model/balance-assessor.js.map +7 -0
  85. package/dist/audit/relationships/model/coverage-analyzer.js +34 -0
  86. package/dist/audit/relationships/model/coverage-analyzer.js.map +7 -0
  87. package/dist/audit/relationships/model/duplicate-detector.js +68 -0
  88. package/dist/audit/relationships/model/duplicate-detector.js.map +7 -0
  89. package/dist/audit/relationships/model/gap-analyzer.js +41 -0
  90. package/dist/audit/relationships/model/gap-analyzer.js.map +7 -0
  91. package/dist/audit/relationships/model/orchestrator.js +126 -0
  92. package/dist/audit/relationships/model/orchestrator.js.map +7 -0
  93. package/dist/audit/relationships/spec/orchestrator.js +157 -0
  94. package/dist/audit/relationships/spec/orchestrator.js.map +7 -0
  95. package/dist/audit/reports/index.js +5 -0
  96. package/dist/audit/reports/index.js.map +7 -0
  97. package/dist/audit/reports/report-generator.js +118 -0
  98. package/dist/audit/reports/report-generator.js.map +7 -0
  99. package/dist/audit/snapshot-storage.js +163 -0
  100. package/dist/audit/snapshot-storage.js.map +7 -0
  101. package/dist/audit/types.js +21 -0
  102. package/dist/audit/types.js.map +7 -0
  103. package/dist/cli.js +223 -92
  104. package/dist/cli.js.map +3 -3
  105. package/dist/coding-agents/agents/claude-code.js +147 -0
  106. package/dist/coding-agents/agents/claude-code.js.map +7 -0
  107. package/dist/coding-agents/agents/index.js +5 -0
  108. package/dist/coding-agents/agents/index.js.map +7 -0
  109. package/dist/coding-agents/agents/types.js +1 -0
  110. package/dist/coding-agents/agents/types.js.map +7 -0
  111. package/dist/coding-agents/base-chat-client.js +45 -0
  112. package/dist/coding-agents/base-chat-client.js.map +7 -0
  113. package/dist/coding-agents/chat-utils.js +23 -0
  114. package/dist/coding-agents/chat-utils.js.map +7 -0
  115. package/dist/coding-agents/claude-code-client.js +246 -0
  116. package/dist/coding-agents/claude-code-client.js.map +7 -0
  117. package/dist/coding-agents/copilot-client.js +209 -0
  118. package/dist/coding-agents/copilot-client.js.map +7 -0
  119. package/dist/commands/add.js +95 -33
  120. package/dist/commands/add.js.map +2 -2
  121. package/dist/commands/analyzer.js +511 -0
  122. package/dist/commands/analyzer.js.map +7 -0
  123. package/dist/commands/audit-diff.js +49 -0
  124. package/dist/commands/audit-diff.js.map +7 -0
  125. package/dist/commands/audit-snapshots.js +62 -0
  126. package/dist/commands/audit-snapshots.js.map +7 -0
  127. package/dist/commands/audit.js +81 -0
  128. package/dist/commands/audit.js.map +7 -0
  129. package/dist/commands/catalog.js +248 -0
  130. package/dist/commands/catalog.js.map +7 -0
  131. package/dist/commands/changeset.js +577 -66
  132. package/dist/commands/changeset.js.map +2 -2
  133. package/dist/commands/chat.js +106 -83
  134. package/dist/commands/chat.js.map +2 -2
  135. package/dist/commands/claude.js +74 -0
  136. package/dist/commands/claude.js.map +7 -0
  137. package/dist/commands/conformance.js +71 -68
  138. package/dist/commands/conformance.js.map +2 -2
  139. package/dist/commands/copilot.js +75 -0
  140. package/dist/commands/copilot.js.map +7 -0
  141. package/dist/commands/delete.js +125 -11
  142. package/dist/commands/delete.js.map +3 -3
  143. package/dist/commands/discover-logic.js +44 -0
  144. package/dist/commands/discover-logic.js.map +7 -0
  145. package/dist/commands/docs.js +87 -0
  146. package/dist/commands/docs.js.map +7 -0
  147. package/dist/commands/element.js +14 -20
  148. package/dist/commands/element.js.map +2 -2
  149. package/dist/commands/export.js +13 -3
  150. package/dist/commands/export.js.map +2 -2
  151. package/dist/commands/import.js +51 -0
  152. package/dist/commands/import.js.map +7 -0
  153. package/dist/commands/info.js +30 -24
  154. package/dist/commands/info.js.map +2 -2
  155. package/dist/commands/init.js +27 -11
  156. package/dist/commands/init.js.map +2 -2
  157. package/dist/commands/list.js +63 -13
  158. package/dist/commands/list.js.map +3 -3
  159. package/dist/commands/relationship.js +225 -37
  160. package/dist/commands/relationship.js.map +2 -2
  161. package/dist/commands/report.js +54 -0
  162. package/dist/commands/report.js.map +7 -0
  163. package/dist/commands/reports.js +45 -0
  164. package/dist/commands/reports.js.map +7 -0
  165. package/dist/commands/schema.js +135 -0
  166. package/dist/commands/schema.js.map +7 -0
  167. package/dist/commands/search.js +40 -12
  168. package/dist/commands/search.js.map +2 -2
  169. package/dist/commands/show.js +58 -27
  170. package/dist/commands/show.js.map +2 -2
  171. package/dist/commands/stats.js +35 -0
  172. package/dist/commands/stats.js.map +7 -0
  173. package/dist/commands/trace.js +39 -16
  174. package/dist/commands/trace.js.map +2 -2
  175. package/dist/commands/update.js +141 -14
  176. package/dist/commands/update.js.map +2 -2
  177. package/dist/commands/upgrade.js +210 -46
  178. package/dist/commands/upgrade.js.map +3 -3
  179. package/dist/commands/validate.js +142 -23
  180. package/dist/commands/validate.js.map +3 -3
  181. package/dist/commands/version.js +8 -12
  182. package/dist/commands/version.js.map +2 -2
  183. package/dist/commands/visualize.js +155 -25
  184. package/dist/commands/visualize.js.map +2 -2
  185. package/dist/core/base-snapshot-manager.js +84 -0
  186. package/dist/core/base-snapshot-manager.js.map +7 -0
  187. package/dist/core/changeset-exporter.js +305 -0
  188. package/dist/core/changeset-exporter.js.map +7 -0
  189. package/dist/core/changeset-validator.js +41 -0
  190. package/dist/core/changeset-validator.js.map +7 -0
  191. package/dist/core/changeset.js +88 -173
  192. package/dist/core/changeset.js.map +2 -2
  193. package/dist/core/dependency-tracker.js +4 -2
  194. package/dist/core/dependency-tracker.js.map +2 -2
  195. package/dist/core/element.js +98 -27
  196. package/dist/core/element.js.map +2 -2
  197. package/dist/core/golden-copy-cache.js +290 -0
  198. package/dist/core/golden-copy-cache.js.map +7 -0
  199. package/dist/core/graph-model.js +266 -0
  200. package/dist/core/graph-model.js.map +7 -0
  201. package/dist/core/layer.js +159 -16
  202. package/dist/core/layer.js.map +2 -2
  203. package/dist/core/layers.js +32 -0
  204. package/dist/core/layers.js.map +7 -0
  205. package/dist/core/manifest.js +32 -11
  206. package/dist/core/manifest.js.map +2 -2
  207. package/dist/core/migration-registry.js +56 -1
  208. package/dist/core/migration-registry.js.map +2 -2
  209. package/dist/core/model.js +424 -217
  210. package/dist/core/model.js.map +3 -3
  211. package/dist/core/mutation-handler.js +179 -0
  212. package/dist/core/mutation-handler.js.map +7 -0
  213. package/dist/core/reference-registry.js +29 -21
  214. package/dist/core/reference-registry.js.map +2 -2
  215. package/dist/core/relationship-catalog.js +189 -0
  216. package/dist/core/relationship-catalog.js.map +7 -0
  217. package/dist/core/relationship-registry.js.map +2 -2
  218. package/dist/core/relationships.js.map +1 -1
  219. package/dist/core/report-data-model.js +285 -0
  220. package/dist/core/report-data-model.js.map +7 -0
  221. package/dist/core/spec-data-service.js +185 -0
  222. package/dist/core/spec-data-service.js.map +7 -0
  223. package/dist/core/spec-loader-types.js +1 -0
  224. package/dist/core/spec-loader-types.js.map +7 -0
  225. package/dist/core/spec-loader.js +234 -0
  226. package/dist/core/spec-loader.js.map +7 -0
  227. package/dist/core/staged-changeset-storage.js +282 -0
  228. package/dist/core/staged-changeset-storage.js.map +7 -0
  229. package/dist/core/staging-area.js +1002 -0
  230. package/dist/core/staging-area.js.map +7 -0
  231. package/dist/core/stats-collector.js +169 -0
  232. package/dist/core/stats-collector.js.map +7 -0
  233. package/dist/core/virtual-projection.js +443 -0
  234. package/dist/core/virtual-projection.js.map +7 -0
  235. package/dist/export/archimate-exporter.js +99 -60
  236. package/dist/export/archimate-exporter.js.map +2 -2
  237. package/dist/export/audit-formatters.js +479 -0
  238. package/dist/export/audit-formatters.js.map +7 -0
  239. package/dist/export/diff-formatters.js +99 -0
  240. package/dist/export/diff-formatters.js.map +7 -0
  241. package/dist/export/export-manager.js.map +2 -2
  242. package/dist/export/graphml-exporter.js +44 -27
  243. package/dist/export/graphml-exporter.js.map +2 -2
  244. package/dist/export/index.js +4 -0
  245. package/dist/export/index.js.map +2 -2
  246. package/dist/export/json-schema-exporter.js +55 -42
  247. package/dist/export/json-schema-exporter.js.map +2 -2
  248. package/dist/export/markdown-exporter.js +92 -70
  249. package/dist/export/markdown-exporter.js.map +2 -2
  250. package/dist/export/markdown-generator.js +248 -0
  251. package/dist/export/markdown-generator.js.map +7 -0
  252. package/dist/export/markdown-utils.js +30 -0
  253. package/dist/export/markdown-utils.js.map +7 -0
  254. package/dist/export/mermaid-markdown-exporter.js +37 -0
  255. package/dist/export/mermaid-markdown-exporter.js.map +7 -0
  256. package/dist/export/openapi-exporter.js +119 -71
  257. package/dist/export/openapi-exporter.js.map +2 -2
  258. package/dist/export/plantuml-exporter.js +104 -39
  259. package/dist/export/plantuml-exporter.js.map +2 -2
  260. package/dist/export/report-formatters.js +111 -0
  261. package/dist/export/report-formatters.js.map +7 -0
  262. package/dist/export/stats-formatters.js +98 -0
  263. package/dist/export/stats-formatters.js.map +7 -0
  264. package/dist/export/types.js +2 -14
  265. package/dist/export/types.js.map +2 -2
  266. package/dist/export/verify-formatters.js +153 -0
  267. package/dist/export/verify-formatters.js.map +7 -0
  268. package/dist/generated/compiled-validators.js +17 -0
  269. package/dist/generated/compiled-validators.js.map +7 -0
  270. package/dist/generated/index.js +31 -0
  271. package/dist/generated/index.js.map +7 -0
  272. package/dist/generated/layer-registry.js +190 -0
  273. package/dist/generated/layer-registry.js.map +7 -0
  274. package/dist/generated/layer-types.js +7 -0
  275. package/dist/generated/layer-types.js.map +7 -0
  276. package/dist/generated/node-types.js +1719 -0
  277. package/dist/generated/node-types.js.map +7 -0
  278. package/dist/generated/relationship-index.js +14552 -0
  279. package/dist/generated/relationship-index.js.map +7 -0
  280. package/dist/import/archimate-importer.js +166 -0
  281. package/dist/import/archimate-importer.js.map +7 -0
  282. package/dist/import/index.js +47 -0
  283. package/dist/import/index.js.map +7 -0
  284. package/dist/import/openapi-importer.js +143 -0
  285. package/dist/import/openapi-importer.js.map +7 -0
  286. package/dist/import/types.js +1 -0
  287. package/dist/import/types.js.map +7 -0
  288. package/dist/integrations/base-manager.js +311 -0
  289. package/dist/integrations/base-manager.js.map +7 -0
  290. package/dist/integrations/claude-manager.js +360 -0
  291. package/dist/integrations/claude-manager.js.map +7 -0
  292. package/dist/integrations/claude_code/agents/dr-advisor.md +253 -0
  293. package/dist/integrations/claude_code/agents/dr-architect.md +278 -0
  294. package/dist/integrations/claude_code/agents/dr-extractor.md +286 -0
  295. package/dist/integrations/claude_code/commands/dr-changeset.md +657 -0
  296. package/dist/integrations/claude_code/commands/dr-design.md +373 -0
  297. package/dist/integrations/claude_code/commands/dr-info.md +132 -0
  298. package/dist/integrations/claude_code/commands/dr-init.md +251 -0
  299. package/dist/integrations/claude_code/commands/dr-map.md +936 -0
  300. package/dist/integrations/claude_code/commands/dr-model.md +493 -0
  301. package/dist/integrations/claude_code/commands/dr-relate.md +814 -0
  302. package/dist/integrations/claude_code/commands/dr-sync.md +279 -0
  303. package/dist/integrations/claude_code/commands/dr-validate.md +654 -0
  304. package/dist/integrations/claude_code/commands/dr-verify.md +559 -0
  305. package/dist/integrations/claude_code/docs/END_TO_END_WALKTHROUGH.md +903 -0
  306. package/dist/integrations/claude_code/docs/QUICK_START.md +271 -0
  307. package/dist/integrations/claude_code/docs/README.md +347 -0
  308. package/dist/integrations/claude_code/skills/dr_01_motivation_layer/SKILL.md +550 -0
  309. package/dist/integrations/claude_code/skills/dr_02_business_layer/SKILL.md +620 -0
  310. package/dist/integrations/claude_code/skills/dr_03_security_layer/SKILL.md +642 -0
  311. package/dist/integrations/claude_code/skills/dr_04_application_layer/SKILL.md +911 -0
  312. package/dist/integrations/claude_code/skills/dr_05_technology_layer/SKILL.md +836 -0
  313. package/dist/integrations/claude_code/skills/dr_06_api_layer/SKILL.md +933 -0
  314. package/dist/integrations/claude_code/skills/dr_07_data_model_layer/SKILL.md +210 -0
  315. package/dist/integrations/claude_code/skills/dr_08_dataset_layer/SKILL.md +319 -0
  316. package/dist/integrations/claude_code/skills/dr_09_ux_layer/SKILL.md +319 -0
  317. package/dist/integrations/claude_code/skills/dr_10_navigation_layer/SKILL.md +318 -0
  318. package/dist/integrations/claude_code/skills/dr_11_apm_layer/SKILL.md +273 -0
  319. package/dist/integrations/claude_code/skills/dr_12_testing_layer/SKILL.md +273 -0
  320. package/dist/integrations/claude_code/skills/dr_changeset_reviewer/SKILL.md +187 -0
  321. package/dist/integrations/claude_code/skills/dr_codebase_memory/SKILL.md +590 -0
  322. package/dist/integrations/claude_code/skills/dr_engineering_guide/SKILL.md +295 -0
  323. package/dist/integrations/copilot-manager.js +328 -0
  324. package/dist/integrations/copilot-manager.js.map +7 -0
  325. package/dist/integrations/github_copilot/agents/dr-advisor.md +243 -0
  326. package/dist/integrations/github_copilot/agents/dr-architect.md +1567 -0
  327. package/dist/integrations/github_copilot/skills/dr_01_motivation_layer/SKILL.md +491 -0
  328. package/dist/integrations/github_copilot/skills/dr_02_business_layer/SKILL.md +539 -0
  329. package/dist/integrations/github_copilot/skills/dr_03_security_layer/SKILL.md +667 -0
  330. package/dist/integrations/github_copilot/skills/dr_04_application_layer/SKILL.md +670 -0
  331. package/dist/integrations/github_copilot/skills/dr_05_technology_layer/SKILL.md +660 -0
  332. package/dist/integrations/github_copilot/skills/dr_06_api_layer/SKILL.md +855 -0
  333. package/dist/integrations/github_copilot/skills/dr_07_data_model_layer/SKILL.md +171 -0
  334. package/dist/integrations/github_copilot/skills/dr_08_dataset_layer/SKILL.md +216 -0
  335. package/dist/integrations/github_copilot/skills/dr_09_ux_layer/SKILL.md +230 -0
  336. package/dist/integrations/github_copilot/skills/dr_10_navigation_layer/SKILL.md +228 -0
  337. package/dist/integrations/github_copilot/skills/dr_11_apm_layer/SKILL.md +234 -0
  338. package/dist/integrations/github_copilot/skills/dr_12_testing_layer/SKILL.md +230 -0
  339. package/dist/integrations/github_copilot/skills/dr_changeset_reviewer/SKILL.md +187 -0
  340. package/dist/integrations/hash-utils.js +51 -0
  341. package/dist/integrations/hash-utils.js.map +7 -0
  342. package/dist/integrations/types.js +16 -0
  343. package/dist/integrations/types.js.map +7 -0
  344. package/dist/reports/model-layer-report-generator.js +278 -0
  345. package/dist/reports/model-layer-report-generator.js.map +7 -0
  346. package/dist/reports/model-report-data.js +57 -0
  347. package/dist/reports/model-report-data.js.map +7 -0
  348. package/dist/reports/model-report-orchestrator.js +103 -0
  349. package/dist/reports/model-report-orchestrator.js.map +7 -0
  350. package/dist/schemas/bundled/analyzers/cbm.json +595 -0
  351. package/dist/schemas/bundled/analyzers/manifest.json +9 -0
  352. package/dist/schemas/bundled/api.json +3411 -0
  353. package/dist/schemas/bundled/apm.json +2371 -0
  354. package/dist/schemas/bundled/application.json +1253 -0
  355. package/dist/schemas/bundled/base.json +1622 -0
  356. package/dist/schemas/bundled/business.json +1279 -0
  357. package/dist/schemas/bundled/data-model.json +1298 -0
  358. package/dist/schemas/bundled/data-store.json +2025 -0
  359. package/dist/schemas/bundled/manifest.json +93 -0
  360. package/dist/schemas/bundled/motivation.json +1360 -0
  361. package/dist/schemas/bundled/navigation.json +1874 -0
  362. package/dist/schemas/bundled/security.json +3488 -0
  363. package/dist/schemas/bundled/technology.json +2067 -0
  364. package/dist/schemas/bundled/testing.json +3120 -0
  365. package/dist/schemas/bundled/ux.json +3592 -0
  366. package/dist/server/schemas.js +202 -0
  367. package/dist/server/schemas.js.map +7 -0
  368. package/dist/server/server.js +1336 -252
  369. package/dist/server/server.js.map +3 -3
  370. package/dist/server/telemetry-middleware.js +22 -15
  371. package/dist/server/telemetry-middleware.js.map +2 -2
  372. package/dist/server-entry.js +65 -0
  373. package/dist/server-entry.js.map +7 -0
  374. package/dist/telemetry/config.js +89 -0
  375. package/dist/telemetry/config.js.map +7 -0
  376. package/dist/telemetry/console-interceptor.js.map +1 -1
  377. package/dist/telemetry/detect.js +24 -0
  378. package/dist/telemetry/detect.js.map +7 -0
  379. package/dist/telemetry/fetch-otlp-exporter.js +112 -0
  380. package/dist/telemetry/fetch-otlp-exporter.js.map +7 -0
  381. package/dist/telemetry/index.js +153 -3
  382. package/dist/telemetry/index.js.map +2 -2
  383. package/dist/telemetry/resilient-exporter.js +22 -8
  384. package/dist/telemetry/resilient-exporter.js.map +2 -2
  385. package/dist/telemetry/resilient-log-exporter.js +17 -8
  386. package/dist/telemetry/resilient-log-exporter.js.map +2 -2
  387. package/dist/telemetry/test-instrumentation.js.map +2 -2
  388. package/dist/types/index.js +84 -0
  389. package/dist/types/index.js.map +3 -3
  390. package/dist/types/source-reference.js +1 -0
  391. package/dist/types/source-reference.js.map +7 -0
  392. package/dist/utils/chat-logger.js +292 -0
  393. package/dist/utils/chat-logger.js.map +7 -0
  394. package/dist/utils/claude-stream.js +8 -0
  395. package/dist/utils/claude-stream.js.map +7 -0
  396. package/dist/utils/date-utils.js +7 -0
  397. package/dist/utils/date-utils.js.map +7 -0
  398. package/dist/utils/element-utils.js.map +1 -1
  399. package/dist/utils/errors.js +88 -15
  400. package/dist/utils/errors.js.map +3 -3
  401. package/dist/utils/export-python-annotations.js +82 -0
  402. package/dist/utils/export-python-annotations.js.map +7 -0
  403. package/dist/utils/file-io.js +7 -2
  404. package/dist/utils/file-io.js.map +2 -2
  405. package/dist/utils/file-lock.js +156 -0
  406. package/dist/utils/file-lock.js.map +7 -0
  407. package/dist/utils/id-generator.js +18 -0
  408. package/dist/utils/id-generator.js.map +7 -0
  409. package/dist/utils/layer-name-formatter.js +16 -0
  410. package/dist/utils/layer-name-formatter.js.map +7 -0
  411. package/dist/utils/markdown-anchor.js +7 -0
  412. package/dist/utils/markdown-anchor.js.map +7 -0
  413. package/dist/utils/markdown-link.js +12 -0
  414. package/dist/utils/markdown-link.js.map +7 -0
  415. package/dist/utils/markdown-table.js +17 -0
  416. package/dist/utils/markdown-table.js.map +7 -0
  417. package/dist/utils/mermaid-utils.js +11 -0
  418. package/dist/utils/mermaid-utils.js.map +7 -0
  419. package/dist/utils/project-paths.js.map +2 -2
  420. package/dist/utils/source-reference.js +52 -0
  421. package/dist/utils/source-reference.js.map +7 -0
  422. package/dist/utils/spec-installer.js +40 -53
  423. package/dist/utils/spec-installer.js.map +2 -2
  424. package/dist/utils/spec-version.js +5 -1
  425. package/dist/utils/spec-version.js.map +2 -2
  426. package/dist/utils/string-utils.js +12 -0
  427. package/dist/utils/string-utils.js.map +7 -0
  428. package/dist/utils/table-formatting.js +19 -0
  429. package/dist/utils/table-formatting.js.map +7 -0
  430. package/dist/validators/index.js +4 -0
  431. package/dist/validators/index.js.map +2 -2
  432. package/dist/validators/naming-validator.js +20 -23
  433. package/dist/validators/naming-validator.js.map +2 -2
  434. package/dist/validators/reference-validator.js +23 -38
  435. package/dist/validators/reference-validator.js.map +2 -2
  436. package/dist/validators/relationship-schema-validator.js +243 -0
  437. package/dist/validators/relationship-schema-validator.js.map +7 -0
  438. package/dist/validators/schema-validator.js +168 -68
  439. package/dist/validators/schema-validator.js.map +2 -2
  440. package/dist/validators/semantic-validator.js +36 -60
  441. package/dist/validators/semantic-validator.js.map +2 -2
  442. package/dist/validators/types.js.map +2 -2
  443. package/dist/validators/validation-formatter.js +159 -0
  444. package/dist/validators/validation-formatter.js.map +7 -0
  445. package/dist/validators/validator.js +24 -38
  446. package/dist/validators/validator.js.map +2 -2
  447. package/dist/viewer/README.md +139 -0
  448. package/dist/viewer/assets/main-CY0Xufuj.css +1 -0
  449. package/dist/viewer/assets/main-DtgErnwF.js +81 -0
  450. package/dist/viewer/assets/vendor-CxKvDp2x.js +17 -0
  451. package/dist/viewer/favicon.svg +11 -0
  452. package/dist/viewer/fonts/inter/Inter-Black.woff2 +0 -0
  453. package/dist/viewer/fonts/inter/Inter-Bold.woff2 +0 -0
  454. package/dist/viewer/fonts/inter/Inter-ExtraBold.woff2 +0 -0
  455. package/dist/viewer/fonts/inter/Inter-Light.woff2 +0 -0
  456. package/dist/viewer/fonts/inter/Inter-Medium.woff2 +0 -0
  457. package/dist/viewer/fonts/inter/Inter-Regular.woff2 +0 -0
  458. package/dist/viewer/fonts/inter/Inter-SemiBold.woff2 +0 -0
  459. package/dist/viewer/fonts/jetbrains-mono/JetBrainsMono-Medium.woff2 +0 -0
  460. package/dist/viewer/fonts/jetbrains-mono/JetBrainsMono-Regular.woff2 +0 -0
  461. package/dist/viewer/fonts/jetbrains-mono/JetBrainsMono-SemiBold.woff2 +0 -0
  462. package/dist/viewer/index.html +15 -0
  463. package/dist/viewer/manifest.json +99 -0
  464. package/dist/viewer/version.json +1 -0
  465. package/package.json +37 -13
  466. package/PYTHON_CLI_PARITY.md +0 -265
  467. package/PYTHON_CLI_STRUCTURE_UPDATE.md +0 -246
  468. package/biome.json +0 -42
  469. package/bunfig.toml +0 -3
  470. package/dist/ai/claude-client.js +0 -71
  471. package/dist/ai/claude-client.js.map +0 -7
  472. package/dist/ai/context-provider.js +0 -129
  473. package/dist/ai/context-provider.js.map +0 -7
  474. package/dist/ai/tools.js +0 -231
  475. package/dist/ai/tools.js.map +0 -7
  476. package/dist/commands/migrate.js +0 -36
  477. package/dist/commands/migrate.js.map +0 -7
  478. package/dist/commands/project.js +0 -74
  479. package/dist/commands/project.js.map +0 -7
  480. package/dist/core/active-changeset.js +0 -52
  481. package/dist/core/active-changeset.js.map +0 -7
  482. package/dist/core/projection-engine.js +0 -288
  483. package/dist/core/projection-engine.js.map +0 -7
  484. package/dist/schemas/bundled/01-motivation-layer.schema.json +0 -942
  485. package/dist/schemas/bundled/02-business-layer.schema.json +0 -1293
  486. package/dist/schemas/bundled/03-security-layer.schema.json +0 -2177
  487. package/dist/schemas/bundled/04-application-layer.schema.json +0 -1328
  488. package/dist/schemas/bundled/05-technology-layer.schema.json +0 -1465
  489. package/dist/schemas/bundled/06-api-layer.schema.json +0 -1743
  490. package/dist/schemas/bundled/07-data-model-layer.schema.json +0 -1253
  491. package/dist/schemas/bundled/08-datastore-layer.schema.json +0 -892
  492. package/dist/schemas/bundled/09-ux-layer.schema.json +0 -1506
  493. package/dist/schemas/bundled/10-navigation-layer.schema.json +0 -843
  494. package/dist/schemas/bundled/11-apm-observability-layer.schema.json +0 -1430
  495. package/dist/schemas/bundled/12-testing-layer.schema.json +0 -1091
  496. package/dist/schemas/bundled/common/layer-extensions.schema.json +0 -266
  497. package/dist/schemas/bundled/common/predicates.schema.json +0 -493
  498. package/dist/schemas/bundled/common/relationships.schema.json +0 -791
  499. package/dist/schemas/bundled/common/source-references.schema.json +0 -71
  500. package/dist/schemas/bundled/link-registry.json +0 -1839
  501. package/dist/schemas/bundled/link-registry.schema.json +0 -339
  502. package/dist/schemas/bundled/relationship-catalog.json +0 -1302
  503. package/dist/schemas/bundled/relationship-type.schema.json +0 -221
  504. package/dist/utils/model-path.js +0 -22
  505. package/dist/utils/model-path.js.map +0 -7
  506. package/docs/TEST-INSTRUMENTATION.md +0 -405
  507. package/docs/telemetry.md +0 -427
  508. package/test-debug.js +0 -33
  509. package/test-special.mjs +0 -46
  510. package/test_runner.ts +0 -7
@@ -1,1743 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://example.com/schemas/06-api-layer.schema.json",
4
- "title": "API Layer Layer Schema",
5
- "description": "Defines REST API contracts using OpenAPI 3.0, specifying endpoints, operations, request/response schemas, and security requirements.",
6
- "layerMetadata": {
7
- "layerId": "06-api-layer",
8
- "layerName": "API Layer",
9
- "intraLayerRelationshipSupport": true,
10
- "crossLayerRelationshipSupport": true,
11
- "relationshipCatalogVersion": "2.1.0"
12
- },
13
- "intraLayerRelationships": {
14
- "$comment": "Relationships between entities within this layer. References relationship-catalog.json by ID.",
15
- "allowed": [
16
- {
17
- "relationshipTypeId": "composition",
18
- "sourceTypes": ["Components", "OpenAPIDocument", "Operation"],
19
- "targetTypes": ["Paths", "Responses", "Schema"],
20
- "examples": [
21
- {
22
- "source": "OpenAPIDocument",
23
- "target": "Paths",
24
- "description": "API document composes paths object defining all endpoints",
25
- "layer": "06-api"
26
- },
27
- {
28
- "source": "Operation",
29
- "target": "Responses",
30
- "description": "API operation composes its responses object",
31
- "layer": "06-api"
32
- },
33
- {
34
- "source": "Components",
35
- "target": "Schema",
36
- "description": "Components object composes reusable schema definitions",
37
- "layer": "06-api"
38
- }
39
- ]
40
- },
41
- {
42
- "relationshipTypeId": "aggregation",
43
- "sourceTypes": ["OpenAPIDocument", "Operation"],
44
- "targetTypes": ["SecurityRequirement", "Server", "Tag"],
45
- "examples": [
46
- {
47
- "source": "OpenAPIDocument",
48
- "target": "Server",
49
- "description": "API document aggregates server definitions",
50
- "layer": "06-api"
51
- },
52
- {
53
- "source": "OpenAPIDocument",
54
- "target": "Tag",
55
- "description": "API document aggregates tag definitions for operation grouping",
56
- "layer": "06-api"
57
- },
58
- {
59
- "source": "Operation",
60
- "target": "SecurityRequirement",
61
- "description": "Operation aggregates its security requirements",
62
- "layer": "06-api"
63
- }
64
- ]
65
- },
66
- {
67
- "relationshipTypeId": "specialization",
68
- "sourceTypes": ["Schema"],
69
- "targetTypes": ["Schema"],
70
- "examples": [
71
- {
72
- "source": "Schema",
73
- "target": "Schema",
74
- "description": "API schema specializes another via allOf/oneOf/anyOf composition",
75
- "layer": "06-api"
76
- }
77
- ]
78
- },
79
- {
80
- "relationshipTypeId": "realization",
81
- "sourceTypes": ["ApplicationService", "Goal", "Outcome"],
82
- "targetTypes": ["BusinessService", "Goal", "Value"],
83
- "examples": [
84
- {
85
- "source": "Goal",
86
- "target": "Value",
87
- "description": "Goal realizes value for stakeholders",
88
- "layer": "01-motivation"
89
- },
90
- {
91
- "source": "Outcome",
92
- "target": "Goal",
93
- "description": "Outcome realizes achievement of goal",
94
- "layer": "01-motivation"
95
- },
96
- {
97
- "source": "ApplicationService",
98
- "target": "BusinessService",
99
- "description": "Application service realizes business service capability"
100
- }
101
- ]
102
- },
103
- {
104
- "relationshipTypeId": "association",
105
- "sourceTypes": ["Contact", "License"],
106
- "targetTypes": ["OpenAPIDocument"],
107
- "examples": [
108
- {
109
- "source": "Contact",
110
- "target": "OpenAPIDocument",
111
- "description": "Contact is associated with API document for support",
112
- "layer": "06-api"
113
- },
114
- {
115
- "source": "License",
116
- "target": "OpenAPIDocument",
117
- "description": "License is associated with API document for legal terms",
118
- "layer": "06-api"
119
- }
120
- ]
121
- },
122
- {
123
- "relationshipTypeId": "triggering",
124
- "sourceTypes": ["Operation"],
125
- "targetTypes": ["Callback"],
126
- "examples": [
127
- {
128
- "source": "Operation",
129
- "target": "Callback",
130
- "description": "API operation triggers callback webhooks on events",
131
- "layer": "06-api"
132
- }
133
- ]
134
- },
135
- {
136
- "relationshipTypeId": "serving",
137
- "sourceTypes": ["SecurityScheme"],
138
- "targetTypes": ["Operation"],
139
- "examples": [
140
- {
141
- "source": "SecurityScheme",
142
- "target": "Operation",
143
- "description": "Security scheme serves operations requiring authentication",
144
- "layer": "06-api"
145
- }
146
- ]
147
- },
148
- {
149
- "relationshipTypeId": "access",
150
- "sourceTypes": ["BusinessProcess", "CoverageRequirement", "TestCaseSketch"],
151
- "targetTypes": ["BusinessObject", "InputPartitionSelection", "InputSelection"],
152
- "examples": [
153
- {
154
- "source": "BusinessProcess",
155
- "target": "BusinessObject",
156
- "description": "Business process accesses business object data"
157
- },
158
- {
159
- "source": "TestCaseSketch",
160
- "target": "InputSelection",
161
- "description": "Test sketch accesses input selections for test execution",
162
- "layer": "12-testing"
163
- },
164
- {
165
- "source": "CoverageRequirement",
166
- "target": "InputPartitionSelection",
167
- "description": "Requirement accesses partition selections for coverage",
168
- "layer": "12-testing"
169
- }
170
- ]
171
- },
172
- {
173
- "relationshipTypeId": "reference",
174
- "sourceTypes": ["Link", "Operation", "Parameter", "Schema"],
175
- "targetTypes": ["Operation", "Schema", "Tag"],
176
- "examples": [
177
- {
178
- "source": "Schema",
179
- "target": "Schema",
180
- "description": "API schema references another schema via $ref",
181
- "layer": "06-api"
182
- },
183
- {
184
- "source": "Parameter",
185
- "target": "Schema",
186
- "description": "Parameter references a schema for its data type",
187
- "layer": "06-api"
188
- },
189
- {
190
- "source": "Link",
191
- "target": "Operation",
192
- "description": "Link references target operation via operationId for HATEOAS",
193
- "layer": "06-api"
194
- }
195
- ]
196
- },
197
- {
198
- "relationshipTypeId": "depends-on",
199
- "sourceTypes": ["ApplicationService", "TestCaseSketch"],
200
- "targetTypes": ["ContextVariation", "DataObject", "OutcomeCategory"],
201
- "examples": [
202
- {
203
- "source": "ApplicationService",
204
- "target": "DataObject",
205
- "description": "Application service depends on data object"
206
- },
207
- {
208
- "source": "TestCaseSketch",
209
- "target": "ContextVariation",
210
- "description": "Test sketch depends on context for execution environment",
211
- "layer": "12-testing"
212
- },
213
- {
214
- "source": "TestCaseSketch",
215
- "target": "OutcomeCategory",
216
- "description": "Test sketch depends on expected outcome category",
217
- "layer": "12-testing"
218
- }
219
- ]
220
- },
221
- {
222
- "relationshipTypeId": "supports-goals",
223
- "sourceTypes": ["BusinessService", "Operation"],
224
- "targetTypes": ["Goal"],
225
- "examples": [
226
- {
227
- "source": "BusinessService",
228
- "sourceLayer": "02-business",
229
- "target": "Goal",
230
- "targetLayer": "01-motivation",
231
- "value": "goal-revenue-growth",
232
- "description": "Payment service supports revenue growth goal"
233
- },
234
- {
235
- "source": "Operation",
236
- "sourceLayer": "06-api",
237
- "target": "Goal",
238
- "targetLayer": "01-motivation",
239
- "value": "goal-customer-satisfaction",
240
- "description": "GET /products operation supports customer satisfaction goal"
241
- }
242
- ]
243
- },
244
- {
245
- "relationshipTypeId": "fulfills-requirements",
246
- "sourceTypes": ["ApplicationService", "Operation"],
247
- "targetTypes": ["Requirement"],
248
- "examples": [
249
- {
250
- "source": "ApplicationService",
251
- "target": "Requirement",
252
- "description": "OAuth service fulfills authentication requirement"
253
- },
254
- {
255
- "source": "Operation",
256
- "sourceLayer": "06-api",
257
- "target": "Requirement",
258
- "targetLayer": "01-motivation",
259
- "value": "req-product-creation-capability",
260
- "description": "POST /products operation fulfills product creation requirement"
261
- }
262
- ]
263
- },
264
- {
265
- "relationshipTypeId": "governed-by-principles",
266
- "sourceTypes": ["APIOperation"],
267
- "targetTypes": ["Principle"],
268
- "examples": [
269
- {
270
- "source": "APIOperation",
271
- "target": "Principle",
272
- "description": "REST API governed by RESTful design principles"
273
- }
274
- ]
275
- },
276
- {
277
- "relationshipTypeId": "constrainedby",
278
- "sourceTypes": ["APIOperation"],
279
- "targetTypes": ["Constraint"],
280
- "examples": [
281
- {
282
- "source": "APIOperation",
283
- "target": "Constraint",
284
- "description": "API operation constrained by rate limit"
285
- }
286
- ]
287
- },
288
- {
289
- "relationshipTypeId": "traces",
290
- "sourceTypes": ["APIOperation"],
291
- "targetTypes": ["DistributedTrace"],
292
- "examples": [
293
- {
294
- "source": "APIOperation",
295
- "target": "DistributedTrace",
296
- "description": "API operation participates in distributed trace"
297
- }
298
- ]
299
- }
300
- ]
301
- },
302
- "crossLayerRelationships": {
303
- "$comment": "Relationships to/from entities in other layers",
304
- "outgoing": [
305
- {
306
- "id": "apm-criticality",
307
- "predicate": "apm-criticality",
308
- "inversePredicate": "referenced-by",
309
- "targetLayer": "11-apm",
310
- "targetTypes": ["Criticality"],
311
- "sourceTypes": ["Operation", "SecurityScheme"],
312
- "fieldPath": "x-apm-criticality",
313
- "cardinality": "single",
314
- "format": "duration",
315
- "strength": "medium",
316
- "required": false,
317
- "description": "enum [low, medium, high, critical] (optional)",
318
- "examples": []
319
- },
320
- {
321
- "id": "apm-sla-target-availability",
322
- "predicate": "sla-target-availability",
323
- "inversePredicate": "referenced-by",
324
- "targetLayer": "11-apm",
325
- "targetTypes": ["SlaTargetAvailability"],
326
- "sourceTypes": ["Operation", "SecurityScheme"],
327
- "fieldPath": "apm.sla-target-availability",
328
- "cardinality": "single",
329
- "format": "percentage",
330
- "strength": "medium",
331
- "required": false,
332
- "description": "string (e.g., \"99.95%\", \"99.99%\", optional)",
333
- "examples": [
334
- {
335
- "elementType": "TechnologyService",
336
- "elementId": "container-platform",
337
- "elementName": "container-platform",
338
- "fieldPath": "apm.sla-target-availability",
339
- "value": "99.95%",
340
- "layer": "05-technology"
341
- },
342
- {
343
- "elementType": "TechnologyService",
344
- "elementId": "database-service",
345
- "elementName": "database-service",
346
- "fieldPath": "apm.sla-target-availability",
347
- "value": "99.99%",
348
- "layer": "05-technology"
349
- }
350
- ]
351
- },
352
- {
353
- "id": "apm-sla-target-latency",
354
- "predicate": "sla-target-latency",
355
- "inversePredicate": "referenced-by",
356
- "targetLayer": "11-apm",
357
- "targetTypes": ["SlaTargetLatency"],
358
- "sourceTypes": ["Operation", "SecurityScheme"],
359
- "fieldPath": "apm.sla-target-latency",
360
- "cardinality": "single",
361
- "format": "duration",
362
- "strength": "medium",
363
- "required": false,
364
- "description": "string (e.g., \"200ms\", \"500ms\", optional)",
365
- "examples": [
366
- {
367
- "elementType": "TechnologyService",
368
- "elementId": "database-service",
369
- "elementName": "database-service",
370
- "fieldPath": "apm.sla-target-latency",
371
- "value": "10ms",
372
- "layer": "05-technology"
373
- }
374
- ]
375
- },
376
- {
377
- "id": "apm-trace",
378
- "predicate": "apm-trace",
379
- "inversePredicate": "referenced-by",
380
- "targetLayer": "11-apm",
381
- "targetTypes": ["Trace"],
382
- "sourceTypes": ["Operation", "SecurityScheme"],
383
- "fieldPath": "x-apm-trace",
384
- "cardinality": "single",
385
- "format": "string",
386
- "strength": "medium",
387
- "required": false,
388
- "description": "boolean (optional)",
389
- "examples": []
390
- },
391
- {
392
- "id": "archimate-ref",
393
- "predicate": "archimate-ref",
394
- "inversePredicate": "referenced-by",
395
- "targetLayer": "04-application",
396
- "targetTypes": ["Element"],
397
- "sourceTypes": ["OpenAPIDocument", "Operation", "SecurityScheme"],
398
- "fieldPath": "x-archimate-ref",
399
- "cardinality": "single",
400
- "format": "duration",
401
- "strength": "medium",
402
- "required": false,
403
- "description": "string (Element.id reference to ApplicationService)",
404
- "examples": []
405
- },
406
- {
407
- "id": "business-apm-business-metrics",
408
- "predicate": "business-metrics",
409
- "inversePredicate": "referenced-by",
410
- "targetLayer": "02-business",
411
- "targetTypes": ["BusinessMetric"],
412
- "sourceTypes": ["Operation", "SecurityScheme"],
413
- "fieldPath": "apm.business-metrics",
414
- "cardinality": "array",
415
- "format": "reference",
416
- "strength": "medium",
417
- "required": false,
418
- "description": "comma-separated business metric IDs this service tracks",
419
- "examples": [
420
- {
421
- "elementType": "BusinessProcess",
422
- "elementId": "order-process",
423
- "elementName": "Order Fulfillment Process",
424
- "fieldPath": "apm.business-metrics",
425
- "value": "metric-order-fulfillment-time,metric-order-success-rate",
426
- "layer": "02-business"
427
- }
428
- ]
429
- },
430
- {
431
- "id": "business-interface-ref",
432
- "predicate": "business-interface-ref",
433
- "inversePredicate": "referenced-by",
434
- "targetLayer": "02-business",
435
- "targetTypes": ["BusinessInterface"],
436
- "sourceTypes": ["Operation", "SecurityScheme"],
437
- "fieldPath": "x-business-interface-ref",
438
- "cardinality": "single",
439
- "format": "duration",
440
- "strength": "medium",
441
- "required": false,
442
- "description": "string (BusinessInterface.id, optional)",
443
- "examples": []
444
- },
445
- {
446
- "id": "business-service-ref",
447
- "predicate": "business-service-ref",
448
- "inversePredicate": "referenced-by",
449
- "targetLayer": "02-business",
450
- "targetTypes": ["BusinessService"],
451
- "sourceTypes": ["Operation", "SecurityScheme"],
452
- "fieldPath": "x-business-service-ref",
453
- "cardinality": "single",
454
- "format": "duration",
455
- "strength": "medium",
456
- "required": false,
457
- "description": "string (BusinessService.id, optional)",
458
- "examples": []
459
- },
460
- {
461
- "id": "database-column",
462
- "predicate": "database-column",
463
- "inversePredicate": "referenced-by",
464
- "targetLayer": "07-data-model",
465
- "targetTypes": ["Column"],
466
- "sourceTypes": ["Schema"],
467
- "fieldPath": "x-database-column",
468
- "cardinality": "single",
469
- "format": "duration",
470
- "strength": "medium",
471
- "required": false,
472
- "description": "string",
473
- "examples": []
474
- },
475
- {
476
- "id": "database-table",
477
- "predicate": "database-table",
478
- "inversePredicate": "referenced-by",
479
- "targetLayer": "07-data-model",
480
- "targetTypes": ["Table"],
481
- "sourceTypes": ["Schema", "SecurityScheme"],
482
- "fieldPath": "x-database-table",
483
- "cardinality": "single",
484
- "format": "duration",
485
- "strength": "medium",
486
- "required": false,
487
- "description": "string",
488
- "examples": []
489
- },
490
- {
491
- "id": "motivation-constrained-by",
492
- "predicate": "constrained-by",
493
- "inversePredicate": "constrains",
494
- "targetLayer": "01-motivation",
495
- "targetTypes": ["ConstrainedBy"],
496
- "sourceTypes": ["Operation", "SecurityScheme"],
497
- "fieldPath": "motivation.constrained-by",
498
- "cardinality": "array",
499
- "format": "reference",
500
- "strength": "medium",
501
- "required": false,
502
- "description": "string[] (Constraint IDs for regulatory/compliance, optional)",
503
- "examples": [
504
- {
505
- "elementType": "Node",
506
- "elementId": "k8s-cluster",
507
- "elementName": "k8s-cluster",
508
- "fieldPath": "motivation.constrained-by",
509
- "value": "constraint-aws-infrastructure,constraint-budget-500k",
510
- "layer": "05-technology"
511
- },
512
- {
513
- "elementType": "Node",
514
- "elementId": "postgres-cluster",
515
- "elementName": "postgres-cluster",
516
- "fieldPath": "motivation.constrained-by",
517
- "value": "constraint-no-proprietary-databases",
518
- "layer": "05-technology"
519
- }
520
- ]
521
- },
522
- {
523
- "id": "motivation-fulfills-requirements",
524
- "predicate": "fulfills-requirements",
525
- "inversePredicate": "fulfilled-by",
526
- "targetLayer": "01-motivation",
527
- "targetTypes": ["FulfillsRequirement"],
528
- "sourceTypes": ["Operation", "SecurityScheme"],
529
- "fieldPath": "motivation.fulfills-requirements",
530
- "cardinality": "array",
531
- "format": "reference",
532
- "strength": "high",
533
- "required": false,
534
- "description": "comma-separated Requirement IDs this function fulfills",
535
- "examples": [
536
- {
537
- "elementType": "Node",
538
- "elementId": "k8s-cluster",
539
- "elementName": "k8s-cluster",
540
- "fieldPath": "motivation.fulfills-requirements",
541
- "value": "req-horizontal-scaling,req-99-95-availability",
542
- "layer": "05-technology"
543
- },
544
- {
545
- "elementType": "Node",
546
- "elementId": "postgres-cluster",
547
- "elementName": "postgres-cluster",
548
- "fieldPath": "motivation.fulfills-requirements",
549
- "value": "req-acid-compliance,req-replication",
550
- "layer": "05-technology"
551
- }
552
- ]
553
- },
554
- {
555
- "id": "motivation-governed-by-principles",
556
- "predicate": "governed-by-principles",
557
- "inversePredicate": "governs",
558
- "targetLayer": "01-motivation",
559
- "targetTypes": ["GovernedByPrinciple"],
560
- "sourceTypes": ["OpenAPIDocument", "Operation", "SecurityScheme"],
561
- "fieldPath": "motivation.governed-by-principles",
562
- "cardinality": "array",
563
- "format": "reference",
564
- "strength": "high",
565
- "required": false,
566
- "description": "BusinessService governed by Principles",
567
- "examples": [
568
- {
569
- "elementType": "BusinessService",
570
- "elementId": "order-service",
571
- "elementName": "Order Processing Service",
572
- "fieldPath": "motivation.governed-by-principles",
573
- "value": "principle-customer-first,principle-automation",
574
- "layer": "02-business"
575
- },
576
- {
577
- "elementType": "ApplicationService",
578
- "elementId": "product-service",
579
- "elementName": "product-service",
580
- "fieldPath": "motivation.governed-by-principles",
581
- "value": "principle-api-first,principle-cloud-native",
582
- "layer": "04-application"
583
- }
584
- ]
585
- },
586
- {
587
- "id": "motivation-supports-goals",
588
- "predicate": "supports-goals",
589
- "inversePredicate": "supported-by",
590
- "targetLayer": "01-motivation",
591
- "targetTypes": ["SupportsGoal"],
592
- "sourceTypes": ["Operation", "SecurityScheme"],
593
- "fieldPath": "motivation.supports-goals",
594
- "cardinality": "array",
595
- "format": "reference",
596
- "strength": "high",
597
- "required": false,
598
- "description": "BusinessService supports Goals",
599
- "examples": [
600
- {
601
- "elementType": "BusinessService",
602
- "elementId": "order-service",
603
- "elementName": "Order Processing Service",
604
- "fieldPath": "motivation.supports-goals",
605
- "value": "goal-customer-satisfaction,goal-revenue-growth",
606
- "layer": "02-business"
607
- },
608
- {
609
- "elementType": "ApplicationService",
610
- "elementId": "product-service",
611
- "elementName": "product-service",
612
- "fieldPath": "motivation.supports-goals",
613
- "value": "goal-product-catalog-accuracy,goal-customer-satisfaction",
614
- "layer": "04-application"
615
- }
616
- ]
617
- },
618
- {
619
- "id": "security-classification",
620
- "predicate": "classification",
621
- "inversePredicate": "referenced-by",
622
- "targetLayer": "03-security",
623
- "targetTypes": ["Classification"],
624
- "sourceTypes": ["Artifact"],
625
- "fieldPath": "security.classification",
626
- "cardinality": "single",
627
- "format": "string",
628
- "strength": "low",
629
- "required": false,
630
- "description": "Links to Classification in target layer",
631
- "examples": [
632
- {
633
- "elementType": "Artifact",
634
- "elementId": "product-db",
635
- "elementName": "product-db",
636
- "fieldPath": "security.classification",
637
- "value": "internal",
638
- "layer": "05-technology"
639
- },
640
- {
641
- "elementType": "Artifact",
642
- "elementId": "customer-db",
643
- "elementName": "customer-db",
644
- "fieldPath": "security.classification",
645
- "value": "restricted",
646
- "layer": "05-technology"
647
- }
648
- ]
649
- },
650
- {
651
- "id": "security-encrypted",
652
- "predicate": "encrypted",
653
- "inversePredicate": "referenced-by",
654
- "targetLayer": "03-security",
655
- "targetTypes": ["Encrypted"],
656
- "sourceTypes": ["Schema"],
657
- "fieldPath": "x-encrypted",
658
- "cardinality": "single",
659
- "format": "string",
660
- "strength": "medium",
661
- "required": false,
662
- "description": "boolean",
663
- "examples": []
664
- },
665
- {
666
- "id": "security-pii",
667
- "predicate": "pii",
668
- "inversePredicate": "referenced-by",
669
- "targetLayer": "03-security",
670
- "targetTypes": ["Pii"],
671
- "sourceTypes": ["Schema"],
672
- "fieldPath": "security.pii",
673
- "cardinality": "single",
674
- "format": "boolean",
675
- "strength": "medium",
676
- "required": false,
677
- "description": "contains personally identifiable information",
678
- "examples": [
679
- {
680
- "elementType": "Artifact",
681
- "elementId": "customer-db",
682
- "elementName": "customer-db",
683
- "fieldPath": "security.pii",
684
- "value": "true",
685
- "layer": "05-technology"
686
- }
687
- ]
688
- },
689
- {
690
- "id": "security-required-permissions",
691
- "predicate": "required-permissions",
692
- "inversePredicate": "referenced-by",
693
- "targetLayer": "03-security",
694
- "targetTypes": ["Permission"],
695
- "sourceTypes": ["Operation", "SecurityScheme"],
696
- "fieldPath": "x-required-permissions",
697
- "cardinality": "array",
698
- "format": "duration",
699
- "strength": "critical",
700
- "required": false,
701
- "description": "string[] (Permission.name[], optional)",
702
- "examples": []
703
- },
704
- {
705
- "id": "security-resource",
706
- "predicate": "security-resource",
707
- "inversePredicate": "referenced-by",
708
- "targetLayer": "03-security",
709
- "targetTypes": ["SecureResource"],
710
- "sourceTypes": ["Operation", "SecurityScheme"],
711
- "fieldPath": "x-security-resource",
712
- "cardinality": "single",
713
- "format": "duration",
714
- "strength": "critical",
715
- "required": false,
716
- "description": "string (SecureResource.resource, optional)",
717
- "examples": []
718
- }
719
- ],
720
- "incoming": []
721
- },
722
- "type": "object",
723
- "properties": {
724
- "open-api-documents": {
725
- "type": "array",
726
- "description": "Collection of OpenAPIDocument entities",
727
- "items": {
728
- "$ref": "#/definitions/OpenAPIDocument"
729
- }
730
- },
731
- "infos": {
732
- "type": "array",
733
- "description": "Collection of Info entities",
734
- "items": {
735
- "$ref": "#/definitions/Info"
736
- }
737
- },
738
- "servers": {
739
- "type": "array",
740
- "description": "Collection of Server entities",
741
- "items": {
742
- "$ref": "#/definitions/Server"
743
- }
744
- },
745
- "pathses": {
746
- "type": "array",
747
- "description": "Collection of Paths entities",
748
- "items": {
749
- "$ref": "#/definitions/Paths"
750
- }
751
- },
752
- "path-items": {
753
- "type": "array",
754
- "description": "Collection of PathItem entities",
755
- "items": {
756
- "$ref": "#/definitions/PathItem"
757
- }
758
- },
759
- "operations": {
760
- "type": "array",
761
- "description": "Collection of Operation entities",
762
- "items": {
763
- "$ref": "#/definitions/Operation"
764
- }
765
- },
766
- "parameters": {
767
- "type": "array",
768
- "description": "Collection of Parameter entities",
769
- "items": {
770
- "$ref": "#/definitions/Parameter"
771
- }
772
- },
773
- "request-bodies": {
774
- "type": "array",
775
- "description": "Collection of RequestBody entities",
776
- "items": {
777
- "$ref": "#/definitions/RequestBody"
778
- }
779
- },
780
- "responseses": {
781
- "type": "array",
782
- "description": "Collection of Responses entities",
783
- "items": {
784
- "$ref": "#/definitions/Responses"
785
- }
786
- },
787
- "responses": {
788
- "type": "array",
789
- "description": "Collection of Response entities",
790
- "items": {
791
- "$ref": "#/definitions/Response"
792
- }
793
- },
794
- "media-types": {
795
- "type": "array",
796
- "description": "Collection of MediaType entities",
797
- "items": {
798
- "$ref": "#/definitions/MediaType"
799
- }
800
- },
801
- "componentses": {
802
- "type": "array",
803
- "description": "Collection of Components entities",
804
- "items": {
805
- "$ref": "#/definitions/Components"
806
- }
807
- },
808
- "schemas": {
809
- "type": "array",
810
- "description": "Collection of Schema entities",
811
- "items": {
812
- "$ref": "#/definitions/Schema"
813
- }
814
- },
815
- "tags": {
816
- "type": "array",
817
- "description": "Collection of Tag entities",
818
- "items": {
819
- "$ref": "#/definitions/Tag"
820
- }
821
- },
822
- "external-documentations": {
823
- "type": "array",
824
- "description": "Collection of ExternalDocumentation entities",
825
- "items": {
826
- "$ref": "#/definitions/ExternalDocumentation"
827
- }
828
- },
829
- "contacts": {
830
- "type": "array",
831
- "description": "Collection of Contact entities",
832
- "items": {
833
- "$ref": "#/definitions/Contact"
834
- }
835
- },
836
- "licenses": {
837
- "type": "array",
838
- "description": "Collection of License entities",
839
- "items": {
840
- "$ref": "#/definitions/License"
841
- }
842
- },
843
- "server-variables": {
844
- "type": "array",
845
- "description": "Collection of ServerVariable entities",
846
- "items": {
847
- "$ref": "#/definitions/ServerVariable"
848
- }
849
- },
850
- "headers": {
851
- "type": "array",
852
- "description": "Collection of Header entities",
853
- "items": {
854
- "$ref": "#/definitions/Header"
855
- }
856
- },
857
- "links": {
858
- "type": "array",
859
- "description": "Collection of Link entities",
860
- "items": {
861
- "$ref": "#/definitions/Link"
862
- }
863
- },
864
- "callbacks": {
865
- "type": "array",
866
- "description": "Collection of Callback entities",
867
- "items": {
868
- "$ref": "#/definitions/Callback"
869
- }
870
- },
871
- "examples": {
872
- "type": "array",
873
- "description": "Collection of Example entities",
874
- "items": {
875
- "$ref": "#/definitions/Example"
876
- }
877
- },
878
- "encodings": {
879
- "type": "array",
880
- "description": "Collection of Encoding entities",
881
- "items": {
882
- "$ref": "#/definitions/Encoding"
883
- }
884
- },
885
- "o-auth-flowses": {
886
- "type": "array",
887
- "description": "Collection of OAuthFlows entities",
888
- "items": {
889
- "$ref": "#/definitions/OAuthFlows"
890
- }
891
- },
892
- "o-auth-flows": {
893
- "type": "array",
894
- "description": "Collection of OAuthFlow entities",
895
- "items": {
896
- "$ref": "#/definitions/OAuthFlow"
897
- }
898
- },
899
- "security-schemes": {
900
- "type": "array",
901
- "description": "Collection of SecurityScheme entities",
902
- "items": {
903
- "$ref": "#/definitions/SecurityScheme"
904
- }
905
- }
906
- },
907
- "definitions": {
908
- "ParameterLocation": {
909
- "type": "string",
910
- "enum": ["query", "header", "path", "cookie"]
911
- },
912
- "ParameterStyle": {
913
- "type": "string",
914
- "enum": ["matrix", "label", "form", "simple", "spaceDelimited", "pipeDelimited", "deepObject"]
915
- },
916
- "SecurityType": {
917
- "type": "string",
918
- "enum": ["apiKey", "http", "oauth2", "openIdConnect"]
919
- },
920
- "OpenAPIDocument": {
921
- "type": "object",
922
- "description": "Root of an OpenAPI specification file",
923
- "required": ["id", "name", "openapi", "info", "servers", "paths", "security", "tags"],
924
- "properties": {
925
- "id": {
926
- "type": "string",
927
- "format": "uuid",
928
- "minLength": 1
929
- },
930
- "name": {
931
- "type": "string",
932
- "minLength": 1
933
- },
934
- "openapi": {
935
- "type": "string",
936
- "minLength": 1
937
- },
938
- "info": {
939
- "type": "string",
940
- "minLength": 1
941
- },
942
- "servers": {
943
- "type": "string",
944
- "minLength": 1
945
- },
946
- "paths": {
947
- "type": "string",
948
- "minLength": 1
949
- },
950
- "components": {
951
- "type": "string",
952
- "minLength": 1
953
- },
954
- "security": {
955
- "type": "string",
956
- "minLength": 1
957
- },
958
- "tags": {
959
- "type": "string",
960
- "minLength": 1
961
- },
962
- "externalDocs": {
963
- "type": "string",
964
- "minLength": 1
965
- }
966
- }
967
- },
968
- "Info": {
969
- "type": "object",
970
- "description": "Metadata about the API",
971
- "required": ["id", "name", "title", "version", "termsOfService"],
972
- "properties": {
973
- "id": {
974
- "type": "string",
975
- "format": "uuid",
976
- "minLength": 1
977
- },
978
- "name": {
979
- "type": "string",
980
- "minLength": 1
981
- },
982
- "title": {
983
- "type": "string",
984
- "minLength": 1
985
- },
986
- "description": {
987
- "type": "string",
988
- "minLength": 1
989
- },
990
- "version": {
991
- "type": "string",
992
- "minLength": 1
993
- },
994
- "termsOfService": {
995
- "type": "string",
996
- "minLength": 1
997
- },
998
- "contact": {
999
- "type": "string",
1000
- "minLength": 1
1001
- },
1002
- "license": {
1003
- "type": "string",
1004
- "minLength": 1
1005
- }
1006
- }
1007
- },
1008
- "Server": {
1009
- "type": "object",
1010
- "description": "Server where the API is available",
1011
- "required": ["id", "name", "url", "variables"],
1012
- "properties": {
1013
- "id": {
1014
- "type": "string",
1015
- "format": "uuid",
1016
- "minLength": 1
1017
- },
1018
- "name": {
1019
- "type": "string",
1020
- "minLength": 1
1021
- },
1022
- "url": {
1023
- "type": "string",
1024
- "minLength": 1
1025
- },
1026
- "description": {
1027
- "type": "string",
1028
- "minLength": 1
1029
- },
1030
- "variables": {
1031
- "type": "string",
1032
- "minLength": 1
1033
- }
1034
- }
1035
- },
1036
- "Paths": {
1037
- "type": "object",
1038
- "description": "Available API endpoints and operations",
1039
- "required": ["id", "name"],
1040
- "properties": {
1041
- "id": {
1042
- "type": "string",
1043
- "format": "uuid",
1044
- "minLength": 1
1045
- },
1046
- "name": {
1047
- "type": "string",
1048
- "minLength": 1
1049
- }
1050
- }
1051
- },
1052
- "PathItem": {
1053
- "type": "object",
1054
- "description": "Operations available on a path",
1055
- "required": ["id", "name", "servers", "parameters"],
1056
- "properties": {
1057
- "id": {
1058
- "type": "string",
1059
- "format": "uuid",
1060
- "minLength": 1
1061
- },
1062
- "name": {
1063
- "type": "string",
1064
- "minLength": 1
1065
- },
1066
- "summary": {
1067
- "type": "string",
1068
- "minLength": 1
1069
- },
1070
- "description": {
1071
- "type": "string",
1072
- "minLength": 1
1073
- },
1074
- "servers": {
1075
- "type": "string",
1076
- "minLength": 1
1077
- },
1078
- "parameters": {
1079
- "type": "string",
1080
- "minLength": 1
1081
- },
1082
- "x-source-reference": {
1083
- "$ref": "common/source-references.schema.json#/definitions/SourceReference",
1084
- "description": "Source code reference using OpenAPI x- extension pattern. This pattern is used for OpenAPI-style layers (API, Data Model, Datastore) to maintain compatibility with OpenAPI tooling, as opposed to the nested properties.source.reference pattern used in ArchiMate-style layers (Application, Technology)."
1085
- }
1086
- }
1087
- },
1088
- "Operation": {
1089
- "type": "object",
1090
- "description": "Single API operation (HTTP method on a path)",
1091
- "required": ["id", "name", "operationId", "summary", "description", "tags"],
1092
- "properties": {
1093
- "id": {
1094
- "type": "string",
1095
- "format": "uuid",
1096
- "minLength": 1
1097
- },
1098
- "name": {
1099
- "type": "string",
1100
- "minLength": 1
1101
- },
1102
- "operationId": {
1103
- "type": "string",
1104
- "minLength": 1
1105
- },
1106
- "summary": {
1107
- "type": "string",
1108
- "minLength": 1
1109
- },
1110
- "description": {
1111
- "type": "string",
1112
- "minLength": 1
1113
- },
1114
- "tags": {
1115
- "type": "string",
1116
- "minLength": 1
1117
- },
1118
- "deprecated": {
1119
- "type": "boolean"
1120
- },
1121
- "parameters": {
1122
- "type": "array",
1123
- "description": "Contains relationship",
1124
- "items": {
1125
- "type": "string"
1126
- }
1127
- },
1128
- "requestBody": {
1129
- "type": "array",
1130
- "description": "Contains relationship",
1131
- "items": {
1132
- "type": "string"
1133
- }
1134
- },
1135
- "responses": {
1136
- "type": "array",
1137
- "description": "Contains relationship",
1138
- "items": {
1139
- "type": "string"
1140
- }
1141
- },
1142
- "callbacks": {
1143
- "type": "array",
1144
- "description": "Contains relationship",
1145
- "items": {
1146
- "type": "string"
1147
- }
1148
- },
1149
- "security": {
1150
- "type": "array",
1151
- "description": "Contains relationship",
1152
- "items": {
1153
- "type": "string"
1154
- }
1155
- },
1156
- "x-source-reference": {
1157
- "$ref": "common/source-references.schema.json#/definitions/SourceReference",
1158
- "description": "Source code reference using OpenAPI x- extension pattern. This pattern is used for OpenAPI-style layers (API, Data Model, Datastore) to maintain compatibility with OpenAPI tooling, as opposed to the nested properties.source.reference pattern used in ArchiMate-style layers (Application, Technology)."
1159
- }
1160
- }
1161
- },
1162
- "Parameter": {
1163
- "type": "object",
1164
- "description": "Parameter for an operation",
1165
- "required": ["id", "name", "in", "required"],
1166
- "properties": {
1167
- "id": {
1168
- "type": "string",
1169
- "format": "uuid",
1170
- "minLength": 1
1171
- },
1172
- "name": {
1173
- "type": "string",
1174
- "minLength": 1
1175
- },
1176
- "in": {
1177
- "type": "string",
1178
- "minLength": 1
1179
- },
1180
- "description": {
1181
- "type": "string",
1182
- "minLength": 1
1183
- },
1184
- "required": {
1185
- "type": "boolean"
1186
- },
1187
- "deprecated": {
1188
- "type": "boolean"
1189
- },
1190
- "allowEmptyValue": {
1191
- "type": "boolean"
1192
- }
1193
- }
1194
- },
1195
- "RequestBody": {
1196
- "type": "object",
1197
- "description": "Request payload for an operation",
1198
- "required": ["id", "name"],
1199
- "properties": {
1200
- "id": {
1201
- "type": "string",
1202
- "format": "uuid",
1203
- "minLength": 1
1204
- },
1205
- "name": {
1206
- "type": "string",
1207
- "minLength": 1
1208
- },
1209
- "description": {
1210
- "type": "string",
1211
- "minLength": 1
1212
- },
1213
- "required": {
1214
- "type": "boolean"
1215
- }
1216
- }
1217
- },
1218
- "Responses": {
1219
- "type": "object",
1220
- "description": "Possible responses from an operation",
1221
- "required": ["id", "name"],
1222
- "properties": {
1223
- "id": {
1224
- "type": "string",
1225
- "format": "uuid",
1226
- "minLength": 1
1227
- },
1228
- "name": {
1229
- "type": "string",
1230
- "minLength": 1
1231
- }
1232
- }
1233
- },
1234
- "Response": {
1235
- "type": "object",
1236
- "description": "Single response definition",
1237
- "required": ["id", "name", "description"],
1238
- "properties": {
1239
- "id": {
1240
- "type": "string",
1241
- "format": "uuid",
1242
- "minLength": 1
1243
- },
1244
- "name": {
1245
- "type": "string",
1246
- "minLength": 1
1247
- },
1248
- "description": {
1249
- "type": "string",
1250
- "minLength": 1
1251
- }
1252
- }
1253
- },
1254
- "MediaType": {
1255
- "type": "object",
1256
- "description": "Media type and schema for request/response body",
1257
- "required": ["id", "name", "contentType"],
1258
- "properties": {
1259
- "id": {
1260
- "type": "string",
1261
- "format": "uuid",
1262
- "minLength": 1
1263
- },
1264
- "name": {
1265
- "type": "string",
1266
- "minLength": 1
1267
- },
1268
- "contentType": {
1269
- "type": "string",
1270
- "minLength": 1
1271
- },
1272
- "example": {
1273
- "type": "string",
1274
- "minLength": 1
1275
- },
1276
- "schema": {
1277
- "type": "array",
1278
- "description": "Contains relationship",
1279
- "items": {
1280
- "type": "string"
1281
- }
1282
- },
1283
- "examples": {
1284
- "type": "array",
1285
- "description": "Contains relationship",
1286
- "items": {
1287
- "type": "string"
1288
- }
1289
- },
1290
- "encoding": {
1291
- "type": "array",
1292
- "description": "Contains relationship",
1293
- "items": {
1294
- "type": "string"
1295
- }
1296
- }
1297
- }
1298
- },
1299
- "Components": {
1300
- "type": "object",
1301
- "description": "Reusable component definitions",
1302
- "required": ["id", "name"],
1303
- "properties": {
1304
- "id": {
1305
- "type": "string",
1306
- "format": "uuid",
1307
- "minLength": 1
1308
- },
1309
- "name": {
1310
- "type": "string",
1311
- "minLength": 1
1312
- },
1313
- "schemas": {
1314
- "type": "array",
1315
- "description": "Contains relationship",
1316
- "items": {
1317
- "type": "string"
1318
- }
1319
- },
1320
- "responses": {
1321
- "type": "array",
1322
- "description": "Contains relationship",
1323
- "items": {
1324
- "type": "string"
1325
- }
1326
- },
1327
- "parameters": {
1328
- "type": "array",
1329
- "description": "Contains relationship",
1330
- "items": {
1331
- "type": "string"
1332
- }
1333
- },
1334
- "examples": {
1335
- "type": "array",
1336
- "description": "Contains relationship",
1337
- "items": {
1338
- "type": "string"
1339
- }
1340
- },
1341
- "requestBodies": {
1342
- "type": "array",
1343
- "description": "Contains relationship",
1344
- "items": {
1345
- "type": "string"
1346
- }
1347
- },
1348
- "headers": {
1349
- "type": "array",
1350
- "description": "Contains relationship",
1351
- "items": {
1352
- "type": "string"
1353
- }
1354
- },
1355
- "securitySchemes": {
1356
- "type": "array",
1357
- "description": "Contains relationship",
1358
- "items": {
1359
- "type": "string"
1360
- }
1361
- },
1362
- "links": {
1363
- "type": "array",
1364
- "description": "Contains relationship",
1365
- "items": {
1366
- "type": "string"
1367
- }
1368
- },
1369
- "callbacks": {
1370
- "type": "array",
1371
- "description": "Contains relationship",
1372
- "items": {
1373
- "type": "string"
1374
- }
1375
- }
1376
- }
1377
- },
1378
- "Schema": {
1379
- "type": "object",
1380
- "description": "Data type definition (JSON Schema subset)",
1381
- "required": ["id", "name", "type", "format"],
1382
- "properties": {
1383
- "id": {
1384
- "type": "string",
1385
- "format": "uuid",
1386
- "minLength": 1
1387
- },
1388
- "name": {
1389
- "type": "string",
1390
- "minLength": 1
1391
- },
1392
- "type": {
1393
- "type": "string",
1394
- "minLength": 1
1395
- },
1396
- "title": {
1397
- "type": "string",
1398
- "minLength": 1
1399
- },
1400
- "description": {
1401
- "type": "string",
1402
- "minLength": 1
1403
- },
1404
- "format": {
1405
- "type": "string",
1406
- "minLength": 1
1407
- },
1408
- "default": {
1409
- "type": "string",
1410
- "minLength": 1
1411
- },
1412
- "enum": {
1413
- "type": "string",
1414
- "minLength": 1
1415
- },
1416
- "nullable": {
1417
- "type": "boolean"
1418
- }
1419
- }
1420
- },
1421
- "Tag": {
1422
- "type": "object",
1423
- "description": "A metadata label used to group and categorize API operations for documentation organization. Enables logical grouping of endpoints in generated API documentation.",
1424
- "required": ["id", "name"],
1425
- "properties": {
1426
- "id": {
1427
- "type": "string",
1428
- "format": "uuid",
1429
- "minLength": 1
1430
- },
1431
- "name": {
1432
- "type": "string",
1433
- "minLength": 1
1434
- },
1435
- "description": {
1436
- "type": "string",
1437
- "minLength": 1
1438
- }
1439
- }
1440
- },
1441
- "ExternalDocumentation": {
1442
- "type": "object",
1443
- "description": "A reference to external documentation resources (URLs, wikis, guides) that provide additional context beyond the inline API specification. Links API elements to comprehensive documentation.",
1444
- "required": ["id", "url"],
1445
- "properties": {
1446
- "id": {
1447
- "type": "string",
1448
- "format": "uuid",
1449
- "minLength": 1
1450
- },
1451
- "description": {
1452
- "type": "string",
1453
- "minLength": 1
1454
- },
1455
- "url": {
1456
- "type": "string",
1457
- "minLength": 1
1458
- }
1459
- }
1460
- },
1461
- "Contact": {
1462
- "type": "object",
1463
- "description": "Contact information for the API owner or maintainer, including name, email, and URL. Enables consumers to reach out for support or collaboration.",
1464
- "required": ["id", "url", "email", "name"],
1465
- "properties": {
1466
- "id": {
1467
- "type": "string",
1468
- "format": "uuid",
1469
- "minLength": 1
1470
- },
1471
- "name": {
1472
- "type": "string",
1473
- "minLength": 1
1474
- },
1475
- "url": {
1476
- "type": "string",
1477
- "minLength": 1
1478
- },
1479
- "email": {
1480
- "type": "string",
1481
- "minLength": 1
1482
- }
1483
- }
1484
- },
1485
- "License": {
1486
- "type": "object",
1487
- "description": "Specifies the legal license under which the API is provided, including license name and URL to full terms. Clarifies usage rights for API consumers.",
1488
- "required": ["id", "name", "url"],
1489
- "properties": {
1490
- "id": {
1491
- "type": "string",
1492
- "format": "uuid",
1493
- "minLength": 1
1494
- },
1495
- "name": {
1496
- "type": "string",
1497
- "minLength": 1
1498
- },
1499
- "url": {
1500
- "type": "string",
1501
- "minLength": 1
1502
- }
1503
- }
1504
- },
1505
- "ServerVariable": {
1506
- "type": "object",
1507
- "description": "A variable placeholder in server URL templates that can be substituted at runtime. Enables dynamic server addressing for different environments or tenants.",
1508
- "required": ["id", "name", "default", "enum"],
1509
- "properties": {
1510
- "id": {
1511
- "type": "string",
1512
- "format": "uuid",
1513
- "minLength": 1
1514
- },
1515
- "name": {
1516
- "type": "string",
1517
- "minLength": 1
1518
- },
1519
- "default": {
1520
- "type": "string",
1521
- "minLength": 1
1522
- },
1523
- "enum": {
1524
- "type": "string",
1525
- "minLength": 1
1526
- },
1527
- "description": {
1528
- "type": "string",
1529
- "minLength": 1
1530
- }
1531
- }
1532
- },
1533
- "Header": {
1534
- "type": "object",
1535
- "description": "Defines HTTP header parameters for requests or responses, specifying name, schema, required status, and description. Documents header-based communication requirements.",
1536
- "required": ["id", "name"],
1537
- "properties": {
1538
- "id": {
1539
- "type": "string",
1540
- "format": "uuid",
1541
- "minLength": 1
1542
- },
1543
- "name": {
1544
- "type": "string",
1545
- "minLength": 1
1546
- },
1547
- "description": {
1548
- "type": "string",
1549
- "minLength": 1
1550
- },
1551
- "required": {
1552
- "type": "boolean"
1553
- },
1554
- "deprecated": {
1555
- "type": "boolean"
1556
- },
1557
- "allowEmptyValue": {
1558
- "type": "boolean"
1559
- }
1560
- }
1561
- },
1562
- "Link": {
1563
- "type": "object",
1564
- "description": "Describes a relationship between API responses and subsequent operations, enabling hypermedia-driven API navigation. Supports HATEOAS design patterns.",
1565
- "required": ["id", "name", "operationId", "operationRef"],
1566
- "properties": {
1567
- "id": {
1568
- "type": "string",
1569
- "format": "uuid",
1570
- "minLength": 1
1571
- },
1572
- "name": {
1573
- "type": "string",
1574
- "minLength": 1
1575
- },
1576
- "operationId": {
1577
- "type": "string",
1578
- "minLength": 1
1579
- },
1580
- "operationRef": {
1581
- "type": "string",
1582
- "minLength": 1
1583
- },
1584
- "description": {
1585
- "type": "string",
1586
- "minLength": 1
1587
- }
1588
- }
1589
- },
1590
- "Callback": {
1591
- "type": "object",
1592
- "description": "Defines a webhook or callback URL pattern where the API will send asynchronous notifications. Enables event-driven integrations and async workflows.",
1593
- "required": ["id", "name"],
1594
- "properties": {
1595
- "id": {
1596
- "type": "string",
1597
- "format": "uuid",
1598
- "minLength": 1
1599
- },
1600
- "name": {
1601
- "type": "string",
1602
- "minLength": 1
1603
- }
1604
- }
1605
- },
1606
- "Example": {
1607
- "type": "object",
1608
- "description": "Provides sample values for request bodies, responses, or parameters. Improves documentation clarity and enables automated testing or mocking.",
1609
- "required": ["id", "name", "summary", "description", "value", "externalValue"],
1610
- "properties": {
1611
- "id": {
1612
- "type": "string",
1613
- "format": "uuid",
1614
- "minLength": 1
1615
- },
1616
- "name": {
1617
- "type": "string",
1618
- "minLength": 1
1619
- },
1620
- "summary": {
1621
- "type": "string",
1622
- "minLength": 1
1623
- },
1624
- "description": {
1625
- "type": "string",
1626
- "minLength": 1
1627
- },
1628
- "value": {
1629
- "type": "string",
1630
- "minLength": 1
1631
- },
1632
- "externalValue": {
1633
- "type": "string",
1634
- "minLength": 1
1635
- }
1636
- }
1637
- },
1638
- "Encoding": {
1639
- "type": "object",
1640
- "description": "Specifies serialization details for multipart request body properties, including content-type, headers, and encoding style. Handles complex content negotiation.",
1641
- "required": ["id", "propertyName", "contentType", "style"],
1642
- "properties": {
1643
- "id": {
1644
- "type": "string",
1645
- "format": "uuid",
1646
- "minLength": 1
1647
- },
1648
- "propertyName": {
1649
- "type": "string",
1650
- "minLength": 1
1651
- },
1652
- "contentType": {
1653
- "type": "string",
1654
- "minLength": 1
1655
- },
1656
- "style": {
1657
- "type": "string",
1658
- "minLength": 1
1659
- },
1660
- "explode": {
1661
- "type": "boolean"
1662
- },
1663
- "allowReserved": {
1664
- "type": "boolean"
1665
- }
1666
- }
1667
- },
1668
- "OAuthFlows": {
1669
- "type": "object",
1670
- "description": "Configuration for OAuth 2.0 authentication flows (implicit, password, clientCredentials, authorizationCode), specifying authorization URLs, token URLs, and scopes. Defines OAuth security implementation.",
1671
- "required": ["id", "name"],
1672
- "properties": {
1673
- "id": {
1674
- "type": "string",
1675
- "format": "uuid",
1676
- "minLength": 1
1677
- },
1678
- "name": {
1679
- "type": "string",
1680
- "minLength": 1
1681
- }
1682
- }
1683
- },
1684
- "OAuthFlow": {
1685
- "type": "object",
1686
- "description": "Individual OAuth 2.0 flow configuration",
1687
- "required": ["authorizationUrl", "tokenUrl", "scopes"],
1688
- "properties": {
1689
- "authorizationUrl": {
1690
- "type": "string",
1691
- "minLength": 1
1692
- },
1693
- "tokenUrl": {
1694
- "type": "string",
1695
- "minLength": 1
1696
- },
1697
- "refreshUrl": {
1698
- "type": "string",
1699
- "minLength": 1
1700
- },
1701
- "scopes": {
1702
- "type": "object"
1703
- }
1704
- }
1705
- },
1706
- "SecurityScheme": {
1707
- "type": "object",
1708
- "description": "Security mechanism for the API",
1709
- "required": ["id", "type", "name", "in", "scheme", "bearerFormat"],
1710
- "properties": {
1711
- "id": {
1712
- "type": "string",
1713
- "format": "uuid",
1714
- "minLength": 1
1715
- },
1716
- "type": {
1717
- "type": "string",
1718
- "minLength": 1
1719
- },
1720
- "description": {
1721
- "type": "string",
1722
- "minLength": 1
1723
- },
1724
- "name": {
1725
- "type": "string",
1726
- "minLength": 1
1727
- },
1728
- "in": {
1729
- "type": "string",
1730
- "minLength": 1
1731
- },
1732
- "scheme": {
1733
- "type": "string",
1734
- "minLength": 1
1735
- },
1736
- "bearerFormat": {
1737
- "type": "string",
1738
- "minLength": 1
1739
- }
1740
- }
1741
- }
1742
- }
1743
- }