aigroup-workflow 2.2.1 → 2.2.2

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 (640) hide show
  1. package/.claude/commands/fix-build.md +10 -5
  2. package/.claude/commands/init-project.md +13 -8
  3. package/.claude/commands/plan.md +15 -8
  4. package/.claude/commands/review.md +12 -6
  5. package/.claude/commands/tdd.md +11 -5
  6. package/.claude/commands/workflow-start.md +20 -11
  7. package/.claude/settings.json +28 -0
  8. package/.codex/agents/architect.toml +207 -0
  9. package/.codex/agents/build-error-resolver.toml +110 -0
  10. package/.codex/agents/code-reviewer.toml +233 -0
  11. package/.codex/agents/doc-updater.toml +103 -0
  12. package/.codex/agents/e2e-runner.toml +103 -0
  13. package/.codex/agents/get-current-datetime.toml +23 -0
  14. package/.codex/agents/init-architect.toml +181 -0
  15. package/.codex/agents/planner.toml +208 -0
  16. package/.codex/agents/refactor-cleaner.toml +81 -0
  17. package/.codex/agents/rust-reviewer.toml +90 -0
  18. package/.codex/agents/security-reviewer.toml +104 -0
  19. package/.codex/agents/tdd-guide.toml +87 -0
  20. package/AGENTS.md +2 -2
  21. package/CLAUDE.md +23 -1
  22. package/LICENSE +20 -20
  23. package/README.md +333 -333
  24. package/agents/a11y-architect.md +141 -141
  25. package/agents/architect.md +211 -211
  26. package/agents/build-error-resolver.md +114 -114
  27. package/agents/chief-of-staff.md +151 -151
  28. package/agents/code-architect.md +71 -71
  29. package/agents/code-explorer.md +69 -69
  30. package/agents/code-reviewer.md +237 -237
  31. package/agents/code-simplifier.md +47 -47
  32. package/agents/comment-analyzer.md +45 -45
  33. package/agents/conversation-analyzer.md +52 -52
  34. package/agents/cpp-build-resolver.md +90 -90
  35. package/agents/cpp-reviewer.md +72 -72
  36. package/agents/csharp-reviewer.md +101 -101
  37. package/agents/dart-build-resolver.md +201 -201
  38. package/agents/database-reviewer.md +91 -91
  39. package/agents/doc-updater.md +107 -107
  40. package/agents/docs-lookup.md +68 -68
  41. package/agents/e2e-runner.md +107 -107
  42. package/agents/flutter-reviewer.md +243 -243
  43. package/agents/gan-evaluator.md +209 -209
  44. package/agents/gan-generator.md +131 -131
  45. package/agents/gan-planner.md +99 -99
  46. package/agents/get-current-datetime.md +26 -26
  47. package/agents/go-build-resolver.md +94 -94
  48. package/agents/go-reviewer.md +76 -76
  49. package/agents/harness-optimizer.md +35 -35
  50. package/agents/healthcare-reviewer.md +83 -83
  51. package/agents/java-build-resolver.md +153 -153
  52. package/agents/java-reviewer.md +92 -92
  53. package/agents/kotlin-build-resolver.md +118 -118
  54. package/agents/kotlin-reviewer.md +159 -159
  55. package/agents/loop-operator.md +36 -36
  56. package/agents/opensource-forker.md +198 -198
  57. package/agents/opensource-packager.md +249 -249
  58. package/agents/opensource-sanitizer.md +188 -188
  59. package/agents/performance-optimizer.md +446 -446
  60. package/agents/planner.md +212 -212
  61. package/agents/pr-test-analyzer.md +45 -45
  62. package/agents/python-reviewer.md +98 -98
  63. package/agents/pytorch-build-resolver.md +120 -120
  64. package/agents/refactor-cleaner.md +85 -85
  65. package/agents/rust-build-resolver.md +148 -148
  66. package/agents/rust-reviewer.md +94 -94
  67. package/agents/security-reviewer.md +108 -108
  68. package/agents/seo-specialist.md +59 -59
  69. package/agents/silent-failure-hunter.md +50 -50
  70. package/agents/tdd-guide.md +91 -91
  71. package/agents/type-design-analyzer.md +41 -41
  72. package/agents/typescript-reviewer.md +112 -112
  73. package/cli/commands/update.mjs +1 -1
  74. package/cli/utils/scaffold.mjs +53 -0
  75. package/docs/rules/agents.md +166 -50
  76. package/docs/rules/cpp/coding-style.md +44 -44
  77. package/docs/rules/cpp/hooks.md +39 -39
  78. package/docs/rules/cpp/patterns.md +51 -51
  79. package/docs/rules/cpp/security.md +51 -51
  80. package/docs/rules/cpp/testing.md +44 -44
  81. package/docs/rules/csharp/coding-style.md +72 -72
  82. package/docs/rules/csharp/hooks.md +25 -25
  83. package/docs/rules/csharp/patterns.md +50 -50
  84. package/docs/rules/csharp/security.md +58 -58
  85. package/docs/rules/csharp/testing.md +46 -46
  86. package/docs/rules/dart/coding-style.md +159 -159
  87. package/docs/rules/dart/hooks.md +66 -66
  88. package/docs/rules/dart/patterns.md +261 -261
  89. package/docs/rules/dart/security.md +135 -135
  90. package/docs/rules/dart/testing.md +215 -215
  91. package/docs/rules/golang/coding-style.md +32 -32
  92. package/docs/rules/golang/hooks.md +17 -17
  93. package/docs/rules/golang/patterns.md +45 -45
  94. package/docs/rules/golang/security.md +34 -34
  95. package/docs/rules/golang/testing.md +31 -31
  96. package/docs/rules/java/coding-style.md +114 -114
  97. package/docs/rules/java/hooks.md +18 -18
  98. package/docs/rules/java/patterns.md +146 -146
  99. package/docs/rules/java/security.md +100 -100
  100. package/docs/rules/java/testing.md +131 -131
  101. package/docs/rules/kotlin/coding-style.md +86 -86
  102. package/docs/rules/kotlin/hooks.md +17 -17
  103. package/docs/rules/kotlin/patterns.md +146 -146
  104. package/docs/rules/kotlin/security.md +82 -82
  105. package/docs/rules/kotlin/testing.md +128 -128
  106. package/docs/rules/perl/coding-style.md +46 -46
  107. package/docs/rules/perl/hooks.md +22 -22
  108. package/docs/rules/perl/patterns.md +76 -76
  109. package/docs/rules/perl/security.md +69 -69
  110. package/docs/rules/perl/testing.md +54 -54
  111. package/docs/rules/php/coding-style.md +40 -40
  112. package/docs/rules/php/hooks.md +24 -24
  113. package/docs/rules/php/patterns.md +33 -33
  114. package/docs/rules/php/security.md +37 -37
  115. package/docs/rules/php/testing.md +39 -39
  116. package/docs/rules/python/coding-style.md +42 -42
  117. package/docs/rules/python/hooks.md +19 -19
  118. package/docs/rules/python/patterns.md +39 -39
  119. package/docs/rules/python/security.md +30 -30
  120. package/docs/rules/python/testing.md +38 -38
  121. package/docs/rules/rust/coding-style.md +151 -151
  122. package/docs/rules/rust/hooks.md +16 -16
  123. package/docs/rules/rust/patterns.md +168 -168
  124. package/docs/rules/rust/security.md +141 -141
  125. package/docs/rules/rust/testing.md +154 -154
  126. package/docs/rules/swift/coding-style.md +47 -47
  127. package/docs/rules/swift/hooks.md +20 -20
  128. package/docs/rules/swift/patterns.md +66 -66
  129. package/docs/rules/swift/security.md +33 -33
  130. package/docs/rules/swift/testing.md +45 -45
  131. package/docs/rules/typescript/coding-style.md +199 -199
  132. package/docs/rules/typescript/hooks.md +22 -22
  133. package/docs/rules/typescript/patterns.md +52 -52
  134. package/docs/rules/typescript/security.md +28 -28
  135. package/docs/rules/typescript/testing.md +18 -18
  136. package/docs/rules/web/coding-style.md +96 -96
  137. package/docs/rules/web/design-quality.md +62 -62
  138. package/docs/rules/web/hooks.md +120 -120
  139. package/docs/rules/web/patterns.md +79 -79
  140. package/docs/rules/web/performance.md +64 -64
  141. package/docs/rules/web/security.md +57 -57
  142. package/docs/rules/web/testing.md +55 -55
  143. package/docs/templates/README.md +36 -36
  144. package/docs/templates/ai-project-final.md +124 -124
  145. package/docs/templates/ai-project.md +105 -105
  146. package/docs/templates/api.md +157 -157
  147. package/docs/templates/bug.md +62 -62
  148. package/docs/templates/code-review.md +87 -87
  149. package/docs/templates/generic.md +116 -116
  150. package/docs/templates/implementation-plan.md +1 -1
  151. package/docs/templates/meeting.md +68 -68
  152. package/docs/templates/prd.md +98 -98
  153. package/docs/templates/ui.md +134 -134
  154. package/docs/workflow-pipeline.md +5 -5
  155. package/package.json +40 -39
  156. package/skills/SUPERPOWERS-LICENSE +21 -21
  157. package/skills/ai-ml/fine-tuning-expert/SKILL.md +162 -162
  158. package/skills/ai-ml/fine-tuning-expert/references/dataset-preparation.md +540 -540
  159. package/skills/ai-ml/fine-tuning-expert/references/deployment-optimization.md +673 -673
  160. package/skills/ai-ml/fine-tuning-expert/references/evaluation-metrics.md +597 -597
  161. package/skills/ai-ml/fine-tuning-expert/references/hyperparameter-tuning.md +565 -565
  162. package/skills/ai-ml/fine-tuning-expert/references/lora-peft.md +347 -347
  163. package/skills/ai-ml/ml-pipeline/SKILL.md +159 -159
  164. package/skills/ai-ml/ml-pipeline/references/experiment-tracking.md +833 -833
  165. package/skills/ai-ml/ml-pipeline/references/feature-engineering.md +631 -631
  166. package/skills/ai-ml/ml-pipeline/references/model-validation.md +978 -978
  167. package/skills/ai-ml/ml-pipeline/references/pipeline-orchestration.md +907 -907
  168. package/skills/ai-ml/ml-pipeline/references/training-pipelines.md +782 -782
  169. package/skills/ai-ml/rag-architect/SKILL.md +194 -194
  170. package/skills/ai-ml/rag-architect/references/chunking-strategies.md +878 -878
  171. package/skills/ai-ml/rag-architect/references/embedding-models.md +561 -561
  172. package/skills/ai-ml/rag-architect/references/rag-evaluation.md +833 -833
  173. package/skills/ai-ml/rag-architect/references/retrieval-optimization.md +795 -795
  174. package/skills/ai-ml/rag-architect/references/vector-databases.md +589 -589
  175. package/skills/ai-ml/spark-engineer/SKILL.md +148 -148
  176. package/skills/ai-ml/spark-engineer/references/partitioning-caching.md +543 -543
  177. package/skills/ai-ml/spark-engineer/references/performance-tuning.md +544 -544
  178. package/skills/ai-ml/spark-engineer/references/rdd-operations.md +599 -599
  179. package/skills/ai-ml/spark-engineer/references/spark-sql-dataframes.md +474 -474
  180. package/skills/ai-ml/spark-engineer/references/streaming-patterns.md +786 -786
  181. package/skills/backend/api-designer/SKILL.md +217 -217
  182. package/skills/backend/api-designer/references/error-handling.md +541 -541
  183. package/skills/backend/api-designer/references/openapi.md +824 -824
  184. package/skills/backend/api-designer/references/pagination.md +494 -494
  185. package/skills/backend/api-designer/references/rest-patterns.md +335 -335
  186. package/skills/backend/api-designer/references/versioning.md +391 -391
  187. package/skills/backend/architecture-designer/SKILL.md +117 -117
  188. package/skills/backend/architecture-designer/references/adr-template.md +116 -116
  189. package/skills/backend/architecture-designer/references/architecture-patterns.md +111 -111
  190. package/skills/backend/architecture-designer/references/database-selection.md +102 -102
  191. package/skills/backend/architecture-designer/references/nfr-checklist.md +112 -112
  192. package/skills/backend/architecture-designer/references/system-design.md +100 -100
  193. package/skills/backend/code-documenter/SKILL.md +147 -147
  194. package/skills/backend/code-documenter/references/api-docs-fastapi-django.md +166 -166
  195. package/skills/backend/code-documenter/references/api-docs-nestjs-express.md +220 -220
  196. package/skills/backend/code-documenter/references/coverage-reports.md +125 -125
  197. package/skills/backend/code-documenter/references/documentation-systems.md +333 -333
  198. package/skills/backend/code-documenter/references/interactive-api-docs.md +531 -531
  199. package/skills/backend/code-documenter/references/python-docstrings.md +121 -121
  200. package/skills/backend/code-documenter/references/typescript-jsdoc.md +145 -145
  201. package/skills/backend/code-documenter/references/user-guides-tutorials.md +530 -530
  202. package/skills/backend/debugging-wizard/SKILL.md +105 -105
  203. package/skills/backend/debugging-wizard/references/common-patterns.md +132 -132
  204. package/skills/backend/debugging-wizard/references/debugging-tools.md +140 -140
  205. package/skills/backend/debugging-wizard/references/quick-fixes.md +177 -177
  206. package/skills/backend/debugging-wizard/references/strategies.md +142 -142
  207. package/skills/backend/debugging-wizard/references/systematic-debugging.md +367 -367
  208. package/skills/backend/feature-forge/SKILL.md +98 -98
  209. package/skills/backend/feature-forge/references/acceptance-criteria.md +104 -104
  210. package/skills/backend/feature-forge/references/ears-syntax.md +99 -99
  211. package/skills/backend/feature-forge/references/interview-questions.md +150 -150
  212. package/skills/backend/feature-forge/references/pre-discovery-subagents.md +54 -54
  213. package/skills/backend/feature-forge/references/specification-template.md +103 -103
  214. package/skills/backend/fullstack-guardian/SKILL.md +105 -105
  215. package/skills/backend/fullstack-guardian/references/api-design-standards.md +307 -307
  216. package/skills/backend/fullstack-guardian/references/architecture-decisions.md +350 -350
  217. package/skills/backend/fullstack-guardian/references/backend-patterns.md +237 -237
  218. package/skills/backend/fullstack-guardian/references/common-patterns.md +134 -134
  219. package/skills/backend/fullstack-guardian/references/deliverables-checklist.md +354 -354
  220. package/skills/backend/fullstack-guardian/references/design-template.md +91 -91
  221. package/skills/backend/fullstack-guardian/references/error-handling.md +135 -135
  222. package/skills/backend/fullstack-guardian/references/frontend-patterns.md +340 -340
  223. package/skills/backend/fullstack-guardian/references/integration-patterns.md +333 -333
  224. package/skills/backend/fullstack-guardian/references/security-checklist.md +106 -106
  225. package/skills/backend/graphql-architect/SKILL.md +146 -146
  226. package/skills/backend/graphql-architect/references/federation.md +418 -418
  227. package/skills/backend/graphql-architect/references/migration-from-rest.md +1141 -1141
  228. package/skills/backend/graphql-architect/references/resolvers.md +425 -425
  229. package/skills/backend/graphql-architect/references/schema-design.md +393 -393
  230. package/skills/backend/graphql-architect/references/security.md +569 -569
  231. package/skills/backend/graphql-architect/references/subscriptions.md +510 -510
  232. package/skills/backend/legacy-modernizer/SKILL.md +137 -137
  233. package/skills/backend/legacy-modernizer/references/legacy-testing.md +381 -381
  234. package/skills/backend/legacy-modernizer/references/migration-strategies.md +423 -423
  235. package/skills/backend/legacy-modernizer/references/refactoring-patterns.md +395 -395
  236. package/skills/backend/legacy-modernizer/references/strangler-fig-pattern.md +281 -281
  237. package/skills/backend/legacy-modernizer/references/system-assessment.md +487 -487
  238. package/skills/backend/microservices-architect/SKILL.md +164 -164
  239. package/skills/backend/microservices-architect/references/communication.md +499 -499
  240. package/skills/backend/microservices-architect/references/data.md +721 -721
  241. package/skills/backend/microservices-architect/references/decomposition.md +344 -344
  242. package/skills/backend/microservices-architect/references/observability.md +805 -805
  243. package/skills/backend/microservices-architect/references/patterns.md +603 -603
  244. package/skills/database/database-optimizer/SKILL.md +147 -147
  245. package/skills/database/database-optimizer/references/index-strategies.md +331 -331
  246. package/skills/database/database-optimizer/references/monitoring-analysis.md +501 -501
  247. package/skills/database/database-optimizer/references/mysql-tuning.md +452 -452
  248. package/skills/database/database-optimizer/references/postgresql-tuning.md +413 -413
  249. package/skills/database/database-optimizer/references/query-optimization.md +251 -251
  250. package/skills/database/postgres-pro/SKILL.md +152 -152
  251. package/skills/database/postgres-pro/references/extensions.md +404 -404
  252. package/skills/database/postgres-pro/references/jsonb.md +321 -321
  253. package/skills/database/postgres-pro/references/maintenance.md +481 -481
  254. package/skills/database/postgres-pro/references/performance.md +265 -265
  255. package/skills/database/postgres-pro/references/replication.md +446 -446
  256. package/skills/database/sql-pro/SKILL.md +129 -129
  257. package/skills/database/sql-pro/references/database-design.md +402 -402
  258. package/skills/database/sql-pro/references/dialect-differences.md +419 -419
  259. package/skills/database/sql-pro/references/optimization.md +384 -384
  260. package/skills/database/sql-pro/references/query-patterns.md +285 -285
  261. package/skills/database/sql-pro/references/window-functions.md +328 -328
  262. package/skills/dotnet/csharp-developer/SKILL.md +125 -125
  263. package/skills/dotnet/csharp-developer/references/aspnet-core.md +394 -394
  264. package/skills/dotnet/csharp-developer/references/blazor.md +553 -553
  265. package/skills/dotnet/csharp-developer/references/entity-framework.md +409 -409
  266. package/skills/dotnet/csharp-developer/references/modern-csharp.md +248 -248
  267. package/skills/dotnet/csharp-developer/references/performance.md +498 -498
  268. package/skills/dotnet/dotnet-core-expert/SKILL.md +138 -138
  269. package/skills/dotnet/dotnet-core-expert/references/authentication.md +546 -546
  270. package/skills/dotnet/dotnet-core-expert/references/clean-architecture.md +455 -455
  271. package/skills/dotnet/dotnet-core-expert/references/cloud-native.md +548 -548
  272. package/skills/dotnet/dotnet-core-expert/references/entity-framework.md +440 -440
  273. package/skills/dotnet/dotnet-core-expert/references/minimal-apis.md +319 -319
  274. package/skills/frontend/angular-architect/SKILL.md +152 -152
  275. package/skills/frontend/angular-architect/references/components.md +297 -297
  276. package/skills/frontend/angular-architect/references/ngrx.md +401 -401
  277. package/skills/frontend/angular-architect/references/routing.md +361 -361
  278. package/skills/frontend/angular-architect/references/rxjs.md +319 -319
  279. package/skills/frontend/angular-architect/references/testing.md +405 -405
  280. package/skills/frontend/design-commands/design.md +91 -91
  281. package/skills/frontend/design-commands/handoff.md +97 -97
  282. package/skills/frontend/design-commands/prototype.md +120 -120
  283. package/skills/frontend/design-commands/spec.md +160 -160
  284. package/skills/frontend/design-commands/style.md +78 -78
  285. package/skills/frontend/flutter-expert/SKILL.md +138 -138
  286. package/skills/frontend/flutter-expert/references/bloc-state.md +259 -259
  287. package/skills/frontend/flutter-expert/references/gorouter-navigation.md +119 -119
  288. package/skills/frontend/flutter-expert/references/performance.md +99 -99
  289. package/skills/frontend/flutter-expert/references/project-structure.md +118 -118
  290. package/skills/frontend/flutter-expert/references/riverpod-state.md +130 -130
  291. package/skills/frontend/flutter-expert/references/widget-patterns.md +123 -123
  292. package/skills/frontend/nextjs-developer/SKILL.md +143 -143
  293. package/skills/frontend/nextjs-developer/references/app-router.md +311 -311
  294. package/skills/frontend/nextjs-developer/references/data-fetching.md +482 -482
  295. package/skills/frontend/nextjs-developer/references/deployment.md +545 -545
  296. package/skills/frontend/nextjs-developer/references/server-actions.md +462 -462
  297. package/skills/frontend/nextjs-developer/references/server-components.md +384 -384
  298. package/skills/frontend/react-expert/SKILL.md +149 -149
  299. package/skills/frontend/react-expert/references/hooks-patterns.md +162 -162
  300. package/skills/frontend/react-expert/references/migration-class-to-modern.md +1119 -1119
  301. package/skills/frontend/react-expert/references/performance.md +168 -168
  302. package/skills/frontend/react-expert/references/react-19-features.md +174 -174
  303. package/skills/frontend/react-expert/references/server-components.md +143 -143
  304. package/skills/frontend/react-expert/references/state-management.md +171 -171
  305. package/skills/frontend/react-expert/references/testing-react.md +174 -174
  306. package/skills/frontend/react-native-expert/SKILL.md +185 -185
  307. package/skills/frontend/react-native-expert/references/expo-router.md +187 -187
  308. package/skills/frontend/react-native-expert/references/list-optimization.md +204 -204
  309. package/skills/frontend/react-native-expert/references/platform-handling.md +188 -188
  310. package/skills/frontend/react-native-expert/references/project-structure.md +171 -171
  311. package/skills/frontend/react-native-expert/references/storage-hooks.md +173 -173
  312. package/skills/frontend/senior-frontend/SKILL.md +477 -477
  313. package/skills/frontend/senior-frontend/references/frontend_best_practices.md +806 -806
  314. package/skills/frontend/senior-frontend/references/nextjs_optimization_guide.md +724 -724
  315. package/skills/frontend/senior-frontend/references/react_patterns.md +746 -746
  316. package/skills/frontend/senior-frontend/scripts/bundle_analyzer.py +407 -407
  317. package/skills/frontend/senior-frontend/scripts/component_generator.py +329 -329
  318. package/skills/frontend/senior-frontend/scripts/frontend_scaffolder.py +1005 -1005
  319. package/skills/frontend/ui-ux-pro-max/SKILL.md +386 -386
  320. package/skills/frontend/ui-ux-pro-max/data/charts.csv +26 -26
  321. package/skills/frontend/ui-ux-pro-max/data/colors.csv +97 -97
  322. package/skills/frontend/ui-ux-pro-max/data/icons.csv +101 -101
  323. package/skills/frontend/ui-ux-pro-max/data/landing.csv +31 -31
  324. package/skills/frontend/ui-ux-pro-max/data/products.csv +96 -96
  325. package/skills/frontend/ui-ux-pro-max/data/react-performance.csv +45 -45
  326. package/skills/frontend/ui-ux-pro-max/data/stacks/astro.csv +54 -54
  327. package/skills/frontend/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
  328. package/skills/frontend/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
  329. package/skills/frontend/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
  330. package/skills/frontend/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
  331. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
  332. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
  333. package/skills/frontend/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
  334. package/skills/frontend/ui-ux-pro-max/data/stacks/react.csv +54 -54
  335. package/skills/frontend/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
  336. package/skills/frontend/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
  337. package/skills/frontend/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
  338. package/skills/frontend/ui-ux-pro-max/data/stacks/vue.csv +50 -50
  339. package/skills/frontend/ui-ux-pro-max/data/styles.csv +68 -68
  340. package/skills/frontend/ui-ux-pro-max/data/typography.csv +57 -57
  341. package/skills/frontend/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
  342. package/skills/frontend/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
  343. package/skills/frontend/ui-ux-pro-max/data/web-interface.csv +31 -31
  344. package/skills/frontend/ui-ux-pro-max/scripts/core.py +253 -253
  345. package/skills/frontend/ui-ux-pro-max/scripts/design_system.py +1067 -1067
  346. package/skills/frontend/ui-ux-pro-max/scripts/search.py +114 -114
  347. package/skills/frontend/vue-expert/SKILL.md +98 -98
  348. package/skills/frontend/vue-expert/references/build-tooling.md +480 -480
  349. package/skills/frontend/vue-expert/references/components.md +448 -448
  350. package/skills/frontend/vue-expert/references/composition-api.md +299 -299
  351. package/skills/frontend/vue-expert/references/mobile-hybrid.md +636 -636
  352. package/skills/frontend/vue-expert/references/nuxt.md +669 -669
  353. package/skills/frontend/vue-expert/references/state-management.md +449 -449
  354. package/skills/frontend/vue-expert/references/typescript.md +584 -584
  355. package/skills/frontend/vue-expert-js/SKILL.md +167 -167
  356. package/skills/frontend/vue-expert-js/references/component-architecture.md +219 -219
  357. package/skills/frontend/vue-expert-js/references/composables-patterns.md +183 -183
  358. package/skills/frontend/vue-expert-js/references/jsdoc-typing.md +535 -535
  359. package/skills/frontend/vue-expert-js/references/state-management.md +249 -249
  360. package/skills/frontend/vue-expert-js/references/testing-patterns.md +237 -237
  361. package/skills/go-rust-cpp/cpp-pro/SKILL.md +115 -115
  362. package/skills/go-rust-cpp/cpp-pro/references/build-tooling.md +440 -440
  363. package/skills/go-rust-cpp/cpp-pro/references/concurrency.md +437 -437
  364. package/skills/go-rust-cpp/cpp-pro/references/memory-performance.md +397 -397
  365. package/skills/go-rust-cpp/cpp-pro/references/modern-cpp.md +304 -304
  366. package/skills/go-rust-cpp/cpp-pro/references/templates.md +357 -357
  367. package/skills/go-rust-cpp/golang-pro/SKILL.md +122 -122
  368. package/skills/go-rust-cpp/golang-pro/references/concurrency.md +329 -329
  369. package/skills/go-rust-cpp/golang-pro/references/generics.md +442 -442
  370. package/skills/go-rust-cpp/golang-pro/references/interfaces.md +432 -432
  371. package/skills/go-rust-cpp/golang-pro/references/project-structure.md +477 -477
  372. package/skills/go-rust-cpp/golang-pro/references/testing.md +451 -451
  373. package/skills/go-rust-cpp/rust-engineer/SKILL.md +167 -167
  374. package/skills/go-rust-cpp/rust-engineer/references/async.md +458 -458
  375. package/skills/go-rust-cpp/rust-engineer/references/error-handling.md +334 -334
  376. package/skills/go-rust-cpp/rust-engineer/references/ownership.md +278 -278
  377. package/skills/go-rust-cpp/rust-engineer/references/testing.md +470 -470
  378. package/skills/go-rust-cpp/rust-engineer/references/traits.md +413 -413
  379. package/skills/infra/cli-developer/SKILL.md +113 -113
  380. package/skills/infra/cli-developer/references/design-patterns.md +221 -221
  381. package/skills/infra/cli-developer/references/go-cli.md +540 -540
  382. package/skills/infra/cli-developer/references/node-cli.md +383 -383
  383. package/skills/infra/cli-developer/references/python-cli.md +422 -422
  384. package/skills/infra/cli-developer/references/ux-patterns.md +448 -448
  385. package/skills/infra/cloud-architect/SKILL.md +216 -216
  386. package/skills/infra/cloud-architect/references/aws.md +394 -394
  387. package/skills/infra/cloud-architect/references/azure.md +562 -562
  388. package/skills/infra/cloud-architect/references/cost.md +582 -582
  389. package/skills/infra/cloud-architect/references/gcp.md +633 -633
  390. package/skills/infra/cloud-architect/references/multi-cloud.md +483 -483
  391. package/skills/infra/devops-engineer/SKILL.md +144 -144
  392. package/skills/infra/devops-engineer/references/deployment-strategies.md +241 -241
  393. package/skills/infra/devops-engineer/references/docker-patterns.md +113 -113
  394. package/skills/infra/devops-engineer/references/github-actions.md +139 -139
  395. package/skills/infra/devops-engineer/references/incident-response.md +331 -331
  396. package/skills/infra/devops-engineer/references/kubernetes.md +154 -154
  397. package/skills/infra/devops-engineer/references/platform-engineering.md +417 -417
  398. package/skills/infra/devops-engineer/references/release-automation.md +527 -527
  399. package/skills/infra/devops-engineer/references/terraform-iac.md +141 -141
  400. package/skills/infra/kubernetes-specialist/SKILL.md +241 -241
  401. package/skills/infra/kubernetes-specialist/references/configuration.md +452 -452
  402. package/skills/infra/kubernetes-specialist/references/cost-optimization.md +458 -458
  403. package/skills/infra/kubernetes-specialist/references/custom-operators.md +563 -563
  404. package/skills/infra/kubernetes-specialist/references/gitops.md +530 -530
  405. package/skills/infra/kubernetes-specialist/references/helm-charts.md +912 -912
  406. package/skills/infra/kubernetes-specialist/references/multi-cluster.md +507 -507
  407. package/skills/infra/kubernetes-specialist/references/networking.md +447 -447
  408. package/skills/infra/kubernetes-specialist/references/service-mesh.md +459 -459
  409. package/skills/infra/kubernetes-specialist/references/storage.md +535 -535
  410. package/skills/infra/kubernetes-specialist/references/troubleshooting.md +414 -414
  411. package/skills/infra/kubernetes-specialist/references/workloads.md +377 -377
  412. package/skills/infra/mcp-developer/SKILL.md +143 -143
  413. package/skills/infra/mcp-developer/references/protocol.md +244 -244
  414. package/skills/infra/mcp-developer/references/python-sdk.md +367 -367
  415. package/skills/infra/mcp-developer/references/resources.md +554 -554
  416. package/skills/infra/mcp-developer/references/tools.md +480 -480
  417. package/skills/infra/mcp-developer/references/typescript-sdk.md +350 -350
  418. package/skills/infra/monitoring-expert/SKILL.md +176 -176
  419. package/skills/infra/monitoring-expert/references/alerting-rules.md +141 -141
  420. package/skills/infra/monitoring-expert/references/application-profiling.md +331 -331
  421. package/skills/infra/monitoring-expert/references/capacity-planning.md +344 -344
  422. package/skills/infra/monitoring-expert/references/dashboards.md +126 -126
  423. package/skills/infra/monitoring-expert/references/opentelemetry.md +123 -123
  424. package/skills/infra/monitoring-expert/references/performance-testing.md +269 -269
  425. package/skills/infra/monitoring-expert/references/prometheus-metrics.md +136 -136
  426. package/skills/infra/monitoring-expert/references/structured-logging.md +142 -142
  427. package/skills/infra/sre-engineer/SKILL.md +181 -181
  428. package/skills/infra/sre-engineer/references/automation-toil.md +492 -492
  429. package/skills/infra/sre-engineer/references/error-budget-policy.md +334 -334
  430. package/skills/infra/sre-engineer/references/incident-chaos.md +576 -576
  431. package/skills/infra/sre-engineer/references/monitoring-alerting.md +424 -424
  432. package/skills/infra/sre-engineer/references/slo-sli-management.md +238 -238
  433. package/skills/infra/terraform-engineer/SKILL.md +143 -143
  434. package/skills/infra/terraform-engineer/references/best-practices.md +583 -583
  435. package/skills/infra/terraform-engineer/references/module-patterns.md +297 -297
  436. package/skills/infra/terraform-engineer/references/providers.md +452 -452
  437. package/skills/infra/terraform-engineer/references/state-management.md +371 -371
  438. package/skills/infra/terraform-engineer/references/testing.md +486 -486
  439. package/skills/infra/websocket-engineer/SKILL.md +168 -168
  440. package/skills/infra/websocket-engineer/references/alternatives.md +391 -391
  441. package/skills/infra/websocket-engineer/references/patterns.md +400 -400
  442. package/skills/infra/websocket-engineer/references/protocol.md +195 -195
  443. package/skills/infra/websocket-engineer/references/scaling.md +333 -333
  444. package/skills/infra/websocket-engineer/references/security.md +474 -474
  445. package/skills/java/java-architect/SKILL.md +132 -132
  446. package/skills/java/java-architect/references/jpa-optimization.md +393 -393
  447. package/skills/java/java-architect/references/reactive-webflux.md +356 -356
  448. package/skills/java/java-architect/references/spring-boot-setup.md +269 -269
  449. package/skills/java/java-architect/references/spring-security.md +445 -445
  450. package/skills/java/java-architect/references/testing-patterns.md +500 -500
  451. package/skills/java/kotlin-specialist/SKILL.md +147 -147
  452. package/skills/java/kotlin-specialist/references/android-compose.md +419 -419
  453. package/skills/java/kotlin-specialist/references/coroutines-flow.md +276 -276
  454. package/skills/java/kotlin-specialist/references/dsl-idioms.md +421 -421
  455. package/skills/java/kotlin-specialist/references/ktor-server.md +426 -426
  456. package/skills/java/kotlin-specialist/references/multiplatform-kmp.md +380 -380
  457. package/skills/java/spring-boot-engineer/SKILL.md +195 -195
  458. package/skills/java/spring-boot-engineer/references/cloud.md +498 -498
  459. package/skills/java/spring-boot-engineer/references/data.md +381 -381
  460. package/skills/java/spring-boot-engineer/references/security.md +459 -459
  461. package/skills/java/spring-boot-engineer/references/testing.md +545 -545
  462. package/skills/java/spring-boot-engineer/references/web.md +295 -295
  463. package/skills/javascript/javascript-pro/SKILL.md +132 -132
  464. package/skills/javascript/javascript-pro/references/async-patterns.md +334 -334
  465. package/skills/javascript/javascript-pro/references/browser-apis.md +398 -398
  466. package/skills/javascript/javascript-pro/references/modern-syntax.md +272 -272
  467. package/skills/javascript/javascript-pro/references/modules.md +357 -357
  468. package/skills/javascript/javascript-pro/references/node-essentials.md +471 -471
  469. package/skills/javascript/nestjs-expert/SKILL.md +206 -206
  470. package/skills/javascript/nestjs-expert/references/authentication.md +166 -166
  471. package/skills/javascript/nestjs-expert/references/controllers-routing.md +111 -111
  472. package/skills/javascript/nestjs-expert/references/dtos-validation.md +153 -153
  473. package/skills/javascript/nestjs-expert/references/migration-from-express.md +1237 -1237
  474. package/skills/javascript/nestjs-expert/references/services-di.md +140 -140
  475. package/skills/javascript/nestjs-expert/references/testing-patterns.md +186 -186
  476. package/skills/javascript/typescript-pro/SKILL.md +145 -145
  477. package/skills/javascript/typescript-pro/references/advanced-types.md +259 -259
  478. package/skills/javascript/typescript-pro/references/configuration.md +445 -445
  479. package/skills/javascript/typescript-pro/references/patterns.md +484 -484
  480. package/skills/javascript/typescript-pro/references/type-guards.md +352 -352
  481. package/skills/javascript/typescript-pro/references/utility-types.md +329 -329
  482. package/skills/php/laravel-specialist/SKILL.md +262 -262
  483. package/skills/php/laravel-specialist/references/eloquent.md +351 -351
  484. package/skills/php/laravel-specialist/references/livewire.md +512 -512
  485. package/skills/php/laravel-specialist/references/queues.md +423 -423
  486. package/skills/php/laravel-specialist/references/routing.md +362 -362
  487. package/skills/php/laravel-specialist/references/testing.md +522 -522
  488. package/skills/php/php-pro/SKILL.md +206 -206
  489. package/skills/php/php-pro/references/async-patterns.md +412 -412
  490. package/skills/php/php-pro/references/laravel-patterns.md +377 -377
  491. package/skills/php/php-pro/references/modern-php-features.md +323 -323
  492. package/skills/php/php-pro/references/symfony-patterns.md +466 -466
  493. package/skills/php/php-pro/references/testing-quality.md +466 -466
  494. package/skills/product/competitive-analysis/SKILL.md +257 -257
  495. package/skills/product/meeting-notes/SKILL.md +266 -266
  496. package/skills/product/prd-template/SKILL.md +150 -150
  497. package/skills/product/stakeholder-update/SKILL.md +225 -225
  498. package/skills/product/user-research-synthesis/SKILL.md +235 -235
  499. package/skills/python/django-expert/SKILL.md +162 -162
  500. package/skills/python/django-expert/references/authentication.md +145 -145
  501. package/skills/python/django-expert/references/drf-serializers.md +148 -148
  502. package/skills/python/django-expert/references/models-orm.md +151 -151
  503. package/skills/python/django-expert/references/testing-django.md +204 -204
  504. package/skills/python/django-expert/references/viewsets-views.md +153 -153
  505. package/skills/python/fastapi-expert/SKILL.md +185 -185
  506. package/skills/python/fastapi-expert/references/async-sqlalchemy.md +146 -146
  507. package/skills/python/fastapi-expert/references/authentication.md +159 -159
  508. package/skills/python/fastapi-expert/references/endpoints-routing.md +142 -142
  509. package/skills/python/fastapi-expert/references/migration-from-django.md +996 -996
  510. package/skills/python/fastapi-expert/references/pydantic-v2.md +135 -135
  511. package/skills/python/fastapi-expert/references/testing-async.md +159 -159
  512. package/skills/python/pandas-pro/SKILL.md +178 -178
  513. package/skills/python/pandas-pro/references/aggregation-groupby.md +545 -545
  514. package/skills/python/pandas-pro/references/data-cleaning.md +500 -500
  515. package/skills/python/pandas-pro/references/dataframe-operations.md +420 -420
  516. package/skills/python/pandas-pro/references/merging-joining.md +596 -596
  517. package/skills/python/pandas-pro/references/performance-optimization.md +597 -597
  518. package/skills/python/python-pro/SKILL.md +177 -177
  519. package/skills/python/python-pro/references/async-patterns.md +356 -356
  520. package/skills/python/python-pro/references/packaging.md +460 -460
  521. package/skills/python/python-pro/references/standard-library.md +378 -378
  522. package/skills/python/python-pro/references/testing.md +404 -404
  523. package/skills/python/python-pro/references/type-system.md +290 -290
  524. package/skills/quality/chaos-engineer/SKILL.md +182 -182
  525. package/skills/quality/chaos-engineer/references/chaos-tools.md +511 -511
  526. package/skills/quality/chaos-engineer/references/experiment-design.md +229 -229
  527. package/skills/quality/chaos-engineer/references/game-days.md +434 -434
  528. package/skills/quality/chaos-engineer/references/infrastructure-chaos.md +348 -348
  529. package/skills/quality/chaos-engineer/references/kubernetes-chaos.md +432 -432
  530. package/skills/quality/code-reviewer/SKILL.md +119 -119
  531. package/skills/quality/code-reviewer/references/common-issues.md +142 -142
  532. package/skills/quality/code-reviewer/references/feedback-examples.md +144 -144
  533. package/skills/quality/code-reviewer/references/receiving-feedback.md +238 -238
  534. package/skills/quality/code-reviewer/references/report-template.md +109 -109
  535. package/skills/quality/code-reviewer/references/review-checklist.md +88 -88
  536. package/skills/quality/code-reviewer/references/spec-compliance-review.md +258 -258
  537. package/skills/quality/playwright-expert/SKILL.md +169 -169
  538. package/skills/quality/playwright-expert/references/api-mocking.md +140 -140
  539. package/skills/quality/playwright-expert/references/configuration.md +155 -155
  540. package/skills/quality/playwright-expert/references/debugging-flaky.md +150 -150
  541. package/skills/quality/playwright-expert/references/page-object-model.md +152 -152
  542. package/skills/quality/playwright-expert/references/selectors-locators.md +119 -119
  543. package/skills/quality/secure-code-guardian/SKILL.md +191 -191
  544. package/skills/quality/secure-code-guardian/references/authentication.md +136 -136
  545. package/skills/quality/secure-code-guardian/references/input-validation.md +146 -146
  546. package/skills/quality/secure-code-guardian/references/owasp-prevention.md +135 -135
  547. package/skills/quality/secure-code-guardian/references/security-headers.md +133 -133
  548. package/skills/quality/secure-code-guardian/references/xss-csrf.md +157 -157
  549. package/skills/quality/security-reviewer/SKILL.md +103 -103
  550. package/skills/quality/security-reviewer/references/infrastructure-security.md +268 -268
  551. package/skills/quality/security-reviewer/references/penetration-testing.md +268 -268
  552. package/skills/quality/security-reviewer/references/report-template.md +170 -170
  553. package/skills/quality/security-reviewer/references/sast-tools.md +117 -117
  554. package/skills/quality/security-reviewer/references/secret-scanning.md +125 -125
  555. package/skills/quality/security-reviewer/references/vulnerability-patterns.md +152 -152
  556. package/skills/quality/senior-qa/README.md +196 -196
  557. package/skills/quality/senior-qa/SKILL.md +399 -399
  558. package/skills/quality/senior-qa/references/qa_best_practices.md +964 -964
  559. package/skills/quality/senior-qa/references/test_automation_patterns.md +1009 -1009
  560. package/skills/quality/senior-qa/references/testing_strategies.md +649 -649
  561. package/skills/quality/senior-qa/scripts/coverage_analyzer.py +836 -836
  562. package/skills/quality/senior-qa/scripts/e2e_test_scaffolder.py +820 -820
  563. package/skills/quality/senior-qa/scripts/test_suite_generator.py +605 -605
  564. package/skills/quality/tdd-guide/HOW_TO_USE.md +313 -313
  565. package/skills/quality/tdd-guide/README.md +680 -680
  566. package/skills/quality/tdd-guide/SKILL.md +122 -122
  567. package/skills/quality/tdd-guide/assets/expected_output.json +77 -77
  568. package/skills/quality/tdd-guide/assets/sample_input_python.json +39 -39
  569. package/skills/quality/tdd-guide/assets/sample_input_typescript.json +36 -36
  570. package/skills/quality/tdd-guide/references/ci-integration.md +195 -195
  571. package/skills/quality/tdd-guide/references/framework-guide.md +206 -206
  572. package/skills/quality/tdd-guide/references/tdd-best-practices.md +128 -128
  573. package/skills/quality/tdd-guide/scripts/coverage_analyzer.py +434 -434
  574. package/skills/quality/tdd-guide/scripts/fixture_generator.py +440 -440
  575. package/skills/quality/tdd-guide/scripts/format_detector.py +384 -384
  576. package/skills/quality/tdd-guide/scripts/framework_adapter.py +428 -428
  577. package/skills/quality/tdd-guide/scripts/metrics_calculator.py +456 -456
  578. package/skills/quality/tdd-guide/scripts/output_formatter.py +354 -354
  579. package/skills/quality/tdd-guide/scripts/tdd_workflow.py +474 -474
  580. package/skills/quality/tdd-guide/scripts/test_generator.py +438 -438
  581. package/skills/quality/test-master/SKILL.md +94 -94
  582. package/skills/quality/test-master/references/automation-frameworks.md +294 -294
  583. package/skills/quality/test-master/references/e2e-testing.md +128 -128
  584. package/skills/quality/test-master/references/integration-testing.md +120 -120
  585. package/skills/quality/test-master/references/performance-testing.md +118 -118
  586. package/skills/quality/test-master/references/qa-methodology.md +247 -247
  587. package/skills/quality/test-master/references/security-testing.md +127 -127
  588. package/skills/quality/test-master/references/tdd-iron-laws.md +174 -174
  589. package/skills/quality/test-master/references/test-reports.md +104 -104
  590. package/skills/quality/test-master/references/testing-anti-patterns.md +231 -231
  591. package/skills/quality/test-master/references/unit-testing.md +113 -113
  592. package/skills/ruby/rails-expert/SKILL.md +154 -154
  593. package/skills/ruby/rails-expert/references/active-record.md +244 -244
  594. package/skills/ruby/rails-expert/references/api-development.md +401 -401
  595. package/skills/ruby/rails-expert/references/background-jobs.md +272 -272
  596. package/skills/ruby/rails-expert/references/hotwire-turbo.md +228 -228
  597. package/skills/ruby/rails-expert/references/rspec-testing.md +367 -367
  598. package/skills/swift/swift-expert/SKILL.md +163 -163
  599. package/skills/swift/swift-expert/references/async-concurrency.md +360 -360
  600. package/skills/swift/swift-expert/references/memory-performance.md +377 -377
  601. package/skills/swift/swift-expert/references/protocol-oriented.md +354 -354
  602. package/skills/swift/swift-expert/references/swiftui-patterns.md +291 -291
  603. package/skills/swift/swift-expert/references/testing-patterns.md +399 -399
  604. package/skills/workflow/brainstorming/SKILL.md +164 -164
  605. package/skills/workflow/brainstorming/scripts/frame-template.html +214 -214
  606. package/skills/workflow/brainstorming/scripts/helper.js +88 -88
  607. package/skills/workflow/brainstorming/scripts/server.cjs +354 -354
  608. package/skills/workflow/brainstorming/scripts/start-server.sh +148 -148
  609. package/skills/workflow/brainstorming/scripts/stop-server.sh +56 -56
  610. package/skills/workflow/brainstorming/spec-document-reviewer-prompt.md +49 -49
  611. package/skills/workflow/brainstorming/visual-companion.md +287 -287
  612. package/skills/workflow/documentation/SKILL.md +45 -45
  613. package/skills/workflow/entropy-management/SKILL.md +115 -115
  614. package/skills/workflow/executing-plans/SKILL.md +70 -70
  615. package/skills/workflow/finishing-a-development-branch/SKILL.md +200 -200
  616. package/skills/workflow/receiving-code-review/SKILL.md +213 -213
  617. package/skills/workflow/requesting-code-review/SKILL.md +105 -105
  618. package/skills/workflow/requesting-code-review/code-reviewer.md +146 -146
  619. package/skills/workflow/requirement-engineering/SKILL.md +111 -111
  620. package/skills/workflow/systematic-debugging/CREATION-LOG.md +119 -119
  621. package/skills/workflow/systematic-debugging/SKILL.md +296 -296
  622. package/skills/workflow/systematic-debugging/condition-based-waiting-example.ts +158 -158
  623. package/skills/workflow/systematic-debugging/condition-based-waiting.md +115 -115
  624. package/skills/workflow/systematic-debugging/defense-in-depth.md +122 -122
  625. package/skills/workflow/systematic-debugging/find-polluter.sh +63 -63
  626. package/skills/workflow/systematic-debugging/root-cause-tracing.md +169 -169
  627. package/skills/workflow/systematic-debugging/test-academic.md +14 -14
  628. package/skills/workflow/systematic-debugging/test-pressure-1.md +58 -58
  629. package/skills/workflow/systematic-debugging/test-pressure-2.md +68 -68
  630. package/skills/workflow/systematic-debugging/test-pressure-3.md +69 -69
  631. package/skills/workflow/using-git-worktrees/SKILL.md +218 -218
  632. package/skills/workflow/verification-before-completion/SKILL.md +139 -139
  633. package/skills/workflow/writing-plans/SKILL.md +151 -151
  634. package/skills/workflow/writing-plans/plan-document-reviewer-prompt.md +49 -49
  635. package/skills/workflow/writing-skills/SKILL.md +655 -655
  636. package/skills/workflow/writing-skills/anthropic-best-practices.md +1150 -1150
  637. package/skills/workflow/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  638. package/skills/workflow/writing-skills/persuasion-principles.md +187 -187
  639. package/skills/workflow/writing-skills/render-graphs.js +168 -168
  640. package/skills/workflow/writing-skills/testing-skills-with-subagents.md +384 -384
@@ -1,531 +1,531 @@
1
- # Interactive API Documentation
2
-
3
- ## OpenAPI 3.1 Advanced Features
4
-
5
- ### Reusable Components
6
-
7
- ```yaml
8
- openapi: 3.1.0
9
- info:
10
- title: Users API
11
- version: 2.0.0
12
-
13
- components:
14
- # Reusable schemas
15
- schemas:
16
- User:
17
- type: object
18
- required: [id, email]
19
- properties:
20
- id:
21
- type: string
22
- format: uuid
23
- example: "123e4567-e89b-12d3-a456-426614174000"
24
- email:
25
- type: string
26
- format: email
27
- example: "user@example.com"
28
-
29
- Error:
30
- type: object
31
- properties:
32
- code:
33
- type: string
34
- message:
35
- type: string
36
- details:
37
- type: object
38
-
39
- PaginatedResponse:
40
- type: object
41
- properties:
42
- data:
43
- type: array
44
- items: {}
45
- total:
46
- type: integer
47
- page:
48
- type: integer
49
-
50
- # Reusable parameters
51
- parameters:
52
- PageParam:
53
- name: page
54
- in: query
55
- schema:
56
- type: integer
57
- default: 1
58
- minimum: 1
59
-
60
- LimitParam:
61
- name: limit
62
- in: query
63
- schema:
64
- type: integer
65
- default: 20
66
- minimum: 1
67
- maximum: 100
68
-
69
- # Security schemes
70
- securitySchemes:
71
- BearerAuth:
72
- type: http
73
- scheme: bearer
74
- bearerFormat: JWT
75
-
76
- ApiKeyAuth:
77
- type: apiKey
78
- in: header
79
- name: X-API-Key
80
-
81
- OAuth2:
82
- type: oauth2
83
- flows:
84
- authorizationCode:
85
- authorizationUrl: https://api.example.com/oauth/authorize
86
- tokenUrl: https://api.example.com/oauth/token
87
- scopes:
88
- read:users: Read user data
89
- write:users: Modify user data
90
-
91
- # Reusable responses
92
- responses:
93
- NotFound:
94
- description: Resource not found
95
- content:
96
- application/json:
97
- schema:
98
- $ref: '#/components/schemas/Error'
99
-
100
- Unauthorized:
101
- description: Authentication required
102
- content:
103
- application/json:
104
- schema:
105
- $ref: '#/components/schemas/Error'
106
-
107
- paths:
108
- /users:
109
- get:
110
- summary: List users
111
- parameters:
112
- - $ref: '#/components/parameters/PageParam'
113
- - $ref: '#/components/parameters/LimitParam'
114
- security:
115
- - BearerAuth: []
116
- responses:
117
- '200':
118
- description: Success
119
- content:
120
- application/json:
121
- schema:
122
- allOf:
123
- - $ref: '#/components/schemas/PaginatedResponse'
124
- - type: object
125
- properties:
126
- data:
127
- type: array
128
- items:
129
- $ref: '#/components/schemas/User'
130
- ```
131
-
132
- ## Interactive Documentation Portals
133
-
134
- ### Swagger UI Customization
135
-
136
- ```javascript
137
- // Custom Swagger UI
138
- const swaggerUi = require('swagger-ui-express');
139
- const swaggerDocument = require('./openapi.json');
140
-
141
- const options = {
142
- customCss: '.swagger-ui .topbar { display: none }',
143
- customSiteTitle: "API Docs",
144
- customfavIcon: "/favicon.ico",
145
- swaggerOptions: {
146
- persistAuthorization: true,
147
- displayRequestDuration: true,
148
- filter: true,
149
- tryItOutEnabled: true,
150
- requestInterceptor: (req) => {
151
- req.headers['X-Custom-Header'] = 'value';
152
- return req;
153
- },
154
- },
155
- };
156
-
157
- app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));
158
- ```
159
-
160
- ### Redoc (Modern Alternative)
161
-
162
- ```html
163
- <!DOCTYPE html>
164
- <html>
165
- <head>
166
- <title>API Documentation</title>
167
- <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
168
- </head>
169
- <body>
170
- <redoc spec-url='./openapi.yaml'
171
- hide-download-button
172
- required-props-first
173
- native-scrollbars
174
- theme='{
175
- "colors": {
176
- "primary": {
177
- "main": "#4285F4"
178
- }
179
- },
180
- "typography": {
181
- "fontSize": "16px",
182
- "fontFamily": "Roboto, sans-serif"
183
- }
184
- }'>
185
- </redoc>
186
- <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
187
- </body>
188
- </html>
189
- ```
190
-
191
- ### Stoplight Elements
192
-
193
- ```javascript
194
- import { API } from '@stoplight/elements';
195
- import '@stoplight/elements/styles.min.css';
196
-
197
- function App() {
198
- return (
199
- <API
200
- apiDescriptionUrl="./openapi.yaml"
201
- router="hash"
202
- layout="sidebar"
203
- tryItCredentialsPolicy="include"
204
- />
205
- );
206
- }
207
- ```
208
-
209
- ## Multi-Protocol Documentation
210
-
211
- ### GraphQL Schema Documentation
212
-
213
- ```graphql
214
- """
215
- User account in the system
216
- """
217
- type User {
218
- """
219
- Unique user identifier
220
- """
221
- id: ID!
222
-
223
- """
224
- User's email address (unique)
225
- @example "user@example.com"
226
- """
227
- email: String!
228
-
229
- """
230
- Display name
231
- @example "John Doe"
232
- """
233
- name: String!
234
-
235
- """
236
- User's posts (paginated)
237
- """
238
- posts(
239
- """Number of items per page (max 100)"""
240
- limit: Int = 20
241
- """Page offset"""
242
- offset: Int = 0
243
- ): PostConnection!
244
- }
245
-
246
- type Query {
247
- """
248
- Fetch a user by ID
249
- """
250
- user(
251
- """User's unique identifier"""
252
- id: ID!
253
- ): User
254
-
255
- """
256
- Search users by name or email
257
- """
258
- searchUsers(
259
- """Search query"""
260
- query: String!
261
- """Maximum results to return"""
262
- limit: Int = 10
263
- ): [User!]!
264
- }
265
-
266
- type Mutation {
267
- """
268
- Create a new user account
269
- """
270
- createUser(
271
- """User creation input"""
272
- input: CreateUserInput!
273
- ): CreateUserPayload!
274
- }
275
-
276
- """
277
- Input for creating a user
278
- """
279
- input CreateUserInput {
280
- """User's email address"""
281
- email: String!
282
- """Display name"""
283
- name: String!
284
- }
285
- ```
286
-
287
- **GraphQL Playground:**
288
- ```javascript
289
- const { ApolloServer } = require('apollo-server');
290
-
291
- const server = new ApolloServer({
292
- typeDefs,
293
- resolvers,
294
- introspection: true, // Enable in dev
295
- playground: {
296
- settings: {
297
- 'editor.theme': 'dark',
298
- 'editor.fontSize': 14,
299
- },
300
- },
301
- });
302
- ```
303
-
304
- ### WebSocket Protocol Documentation
305
-
306
- ```yaml
307
- # AsyncAPI 2.0
308
- asyncapi: 2.5.0
309
- info:
310
- title: Chat WebSocket API
311
- version: 1.0.0
312
- description: Real-time chat messaging
313
-
314
- channels:
315
- chat/{roomId}:
316
- parameters:
317
- roomId:
318
- description: Chat room identifier
319
- schema:
320
- type: string
321
-
322
- subscribe:
323
- summary: Receive messages
324
- message:
325
- oneOf:
326
- - $ref: '#/components/messages/ChatMessage'
327
- - $ref: '#/components/messages/UserJoined'
328
-
329
- publish:
330
- summary: Send a message
331
- message:
332
- $ref: '#/components/messages/ChatMessage'
333
-
334
- components:
335
- messages:
336
- ChatMessage:
337
- name: message
338
- payload:
339
- type: object
340
- properties:
341
- userId:
342
- type: string
343
- content:
344
- type: string
345
- timestamp:
346
- type: string
347
- format: date-time
348
-
349
- UserJoined:
350
- name: userJoined
351
- payload:
352
- type: object
353
- properties:
354
- userId:
355
- type: string
356
- username:
357
- type: string
358
- ```
359
-
360
- ### gRPC Documentation
361
-
362
- ```protobuf
363
- syntax = "proto3";
364
-
365
- package users.v1;
366
-
367
- // User service manages user accounts
368
- service UserService {
369
- // Get a user by ID
370
- // Returns: User object or NOT_FOUND error
371
- rpc GetUser(GetUserRequest) returns (User) {}
372
-
373
- // List all users with pagination
374
- // Returns: Paginated list of users
375
- rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {}
376
-
377
- // Create a new user
378
- // Returns: Created user or ALREADY_EXISTS error
379
- rpc CreateUser(CreateUserRequest) returns (User) {}
380
-
381
- // Stream user updates in real-time
382
- // Returns: Stream of user update events
383
- rpc WatchUsers(WatchUsersRequest) returns (stream UserEvent) {}
384
- }
385
-
386
- // User account
387
- message User {
388
- // Unique identifier
389
- string id = 1;
390
-
391
- // Email address (unique, required)
392
- string email = 2;
393
-
394
- // Display name
395
- string name = 3;
396
-
397
- // Account creation timestamp
398
- google.protobuf.Timestamp created_at = 4;
399
- }
400
- ```
401
-
402
- ## SDK Documentation Strategies
403
-
404
- ### Multi-Language Examples
405
-
406
- ```markdown
407
- # Create User
408
-
409
- ## Python
410
- ```python
411
- from myapi import Client
412
-
413
- client = Client(api_key="your_key")
414
- user = client.users.create(
415
- name="John Doe",
416
- email="john@example.com"
417
- )
418
- print(user.id)
419
- ```
420
-
421
- ## TypeScript
422
- ```typescript
423
- import { Client } from '@myapi/sdk';
424
-
425
- const client = new Client({ apiKey: 'your_key' });
426
- const user = await client.users.create({
427
- name: 'John Doe',
428
- email: 'john@example.com',
429
- });
430
- console.log(user.id);
431
- ```
432
-
433
- ## Go
434
- ```go
435
- import "github.com/myapi/sdk-go"
436
-
437
- client := sdk.NewClient("your_key")
438
- user, err := client.Users.Create(ctx, &sdk.CreateUserInput{
439
- Name: "John Doe",
440
- Email: "john@example.com",
441
- })
442
- if err != nil {
443
- log.Fatal(err)
444
- }
445
- fmt.Println(user.ID)
446
- ```
447
-
448
- ## Ruby
449
- ```ruby
450
- require 'myapi'
451
-
452
- client = MyAPI::Client.new(api_key: 'your_key')
453
- user = client.users.create(
454
- name: 'John Doe',
455
- email: 'john@example.com'
456
- )
457
- puts user.id
458
- ```
459
- ```
460
-
461
- ### SDK Reference Template
462
-
463
- ```markdown
464
- # Users SDK
465
-
466
- ## Installation
467
- ```bash
468
- npm install @myapi/sdk
469
- ```
470
-
471
- ## Configuration
472
- ```typescript
473
- import { Client } from '@myapi/sdk';
474
-
475
- const client = new Client({
476
- apiKey: process.env.API_KEY,
477
- baseUrl: 'https://api.example.com', // Optional
478
- timeout: 30000, // Optional, default 30s
479
- });
480
- ```
481
-
482
- ## Methods
483
-
484
- ### `client.users.create(data)`
485
- Create a new user.
486
-
487
- **Parameters:**
488
- - `data.name` (string, required) - User's display name
489
- - `data.email` (string, required) - User's email address
490
-
491
- **Returns:** Promise<User>
492
-
493
- **Throws:**
494
- - `ValidationError` - Invalid input data
495
- - `ConflictError` - Email already exists
496
- - `AuthenticationError` - Invalid API key
497
-
498
- **Example:**
499
- ```typescript
500
- const user = await client.users.create({
501
- name: 'John Doe',
502
- email: 'john@example.com',
503
- });
504
- ```
505
-
506
- ## Error Handling
507
- ```typescript
508
- import { ValidationError, ConflictError } from '@myapi/sdk';
509
-
510
- try {
511
- await client.users.create(data);
512
- } catch (error) {
513
- if (error instanceof ValidationError) {
514
- console.error('Invalid data:', error.fields);
515
- } else if (error instanceof ConflictError) {
516
- console.error('User already exists');
517
- }
518
- }
519
- ```
520
- ```
521
-
522
- ## Quick Reference
523
-
524
- | Tool | Protocol | Features |
525
- |------|----------|----------|
526
- | Swagger UI | REST | Try-it-out, auth |
527
- | Redoc | REST | Clean, responsive |
528
- | Stoplight | REST | Modern, mock server |
529
- | GraphQL Playground | GraphQL | Explorer, history |
530
- | AsyncAPI Studio | WebSocket | Visual editor |
531
- | grpcui | gRPC | Interactive console |
1
+ # Interactive API Documentation
2
+
3
+ ## OpenAPI 3.1 Advanced Features
4
+
5
+ ### Reusable Components
6
+
7
+ ```yaml
8
+ openapi: 3.1.0
9
+ info:
10
+ title: Users API
11
+ version: 2.0.0
12
+
13
+ components:
14
+ # Reusable schemas
15
+ schemas:
16
+ User:
17
+ type: object
18
+ required: [id, email]
19
+ properties:
20
+ id:
21
+ type: string
22
+ format: uuid
23
+ example: "123e4567-e89b-12d3-a456-426614174000"
24
+ email:
25
+ type: string
26
+ format: email
27
+ example: "user@example.com"
28
+
29
+ Error:
30
+ type: object
31
+ properties:
32
+ code:
33
+ type: string
34
+ message:
35
+ type: string
36
+ details:
37
+ type: object
38
+
39
+ PaginatedResponse:
40
+ type: object
41
+ properties:
42
+ data:
43
+ type: array
44
+ items: {}
45
+ total:
46
+ type: integer
47
+ page:
48
+ type: integer
49
+
50
+ # Reusable parameters
51
+ parameters:
52
+ PageParam:
53
+ name: page
54
+ in: query
55
+ schema:
56
+ type: integer
57
+ default: 1
58
+ minimum: 1
59
+
60
+ LimitParam:
61
+ name: limit
62
+ in: query
63
+ schema:
64
+ type: integer
65
+ default: 20
66
+ minimum: 1
67
+ maximum: 100
68
+
69
+ # Security schemes
70
+ securitySchemes:
71
+ BearerAuth:
72
+ type: http
73
+ scheme: bearer
74
+ bearerFormat: JWT
75
+
76
+ ApiKeyAuth:
77
+ type: apiKey
78
+ in: header
79
+ name: X-API-Key
80
+
81
+ OAuth2:
82
+ type: oauth2
83
+ flows:
84
+ authorizationCode:
85
+ authorizationUrl: https://api.example.com/oauth/authorize
86
+ tokenUrl: https://api.example.com/oauth/token
87
+ scopes:
88
+ read:users: Read user data
89
+ write:users: Modify user data
90
+
91
+ # Reusable responses
92
+ responses:
93
+ NotFound:
94
+ description: Resource not found
95
+ content:
96
+ application/json:
97
+ schema:
98
+ $ref: '#/components/schemas/Error'
99
+
100
+ Unauthorized:
101
+ description: Authentication required
102
+ content:
103
+ application/json:
104
+ schema:
105
+ $ref: '#/components/schemas/Error'
106
+
107
+ paths:
108
+ /users:
109
+ get:
110
+ summary: List users
111
+ parameters:
112
+ - $ref: '#/components/parameters/PageParam'
113
+ - $ref: '#/components/parameters/LimitParam'
114
+ security:
115
+ - BearerAuth: []
116
+ responses:
117
+ '200':
118
+ description: Success
119
+ content:
120
+ application/json:
121
+ schema:
122
+ allOf:
123
+ - $ref: '#/components/schemas/PaginatedResponse'
124
+ - type: object
125
+ properties:
126
+ data:
127
+ type: array
128
+ items:
129
+ $ref: '#/components/schemas/User'
130
+ ```
131
+
132
+ ## Interactive Documentation Portals
133
+
134
+ ### Swagger UI Customization
135
+
136
+ ```javascript
137
+ // Custom Swagger UI
138
+ const swaggerUi = require('swagger-ui-express');
139
+ const swaggerDocument = require('./openapi.json');
140
+
141
+ const options = {
142
+ customCss: '.swagger-ui .topbar { display: none }',
143
+ customSiteTitle: "API Docs",
144
+ customfavIcon: "/favicon.ico",
145
+ swaggerOptions: {
146
+ persistAuthorization: true,
147
+ displayRequestDuration: true,
148
+ filter: true,
149
+ tryItOutEnabled: true,
150
+ requestInterceptor: (req) => {
151
+ req.headers['X-Custom-Header'] = 'value';
152
+ return req;
153
+ },
154
+ },
155
+ };
156
+
157
+ app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));
158
+ ```
159
+
160
+ ### Redoc (Modern Alternative)
161
+
162
+ ```html
163
+ <!DOCTYPE html>
164
+ <html>
165
+ <head>
166
+ <title>API Documentation</title>
167
+ <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
168
+ </head>
169
+ <body>
170
+ <redoc spec-url='./openapi.yaml'
171
+ hide-download-button
172
+ required-props-first
173
+ native-scrollbars
174
+ theme='{
175
+ "colors": {
176
+ "primary": {
177
+ "main": "#4285F4"
178
+ }
179
+ },
180
+ "typography": {
181
+ "fontSize": "16px",
182
+ "fontFamily": "Roboto, sans-serif"
183
+ }
184
+ }'>
185
+ </redoc>
186
+ <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
187
+ </body>
188
+ </html>
189
+ ```
190
+
191
+ ### Stoplight Elements
192
+
193
+ ```javascript
194
+ import { API } from '@stoplight/elements';
195
+ import '@stoplight/elements/styles.min.css';
196
+
197
+ function App() {
198
+ return (
199
+ <API
200
+ apiDescriptionUrl="./openapi.yaml"
201
+ router="hash"
202
+ layout="sidebar"
203
+ tryItCredentialsPolicy="include"
204
+ />
205
+ );
206
+ }
207
+ ```
208
+
209
+ ## Multi-Protocol Documentation
210
+
211
+ ### GraphQL Schema Documentation
212
+
213
+ ```graphql
214
+ """
215
+ User account in the system
216
+ """
217
+ type User {
218
+ """
219
+ Unique user identifier
220
+ """
221
+ id: ID!
222
+
223
+ """
224
+ User's email address (unique)
225
+ @example "user@example.com"
226
+ """
227
+ email: String!
228
+
229
+ """
230
+ Display name
231
+ @example "John Doe"
232
+ """
233
+ name: String!
234
+
235
+ """
236
+ User's posts (paginated)
237
+ """
238
+ posts(
239
+ """Number of items per page (max 100)"""
240
+ limit: Int = 20
241
+ """Page offset"""
242
+ offset: Int = 0
243
+ ): PostConnection!
244
+ }
245
+
246
+ type Query {
247
+ """
248
+ Fetch a user by ID
249
+ """
250
+ user(
251
+ """User's unique identifier"""
252
+ id: ID!
253
+ ): User
254
+
255
+ """
256
+ Search users by name or email
257
+ """
258
+ searchUsers(
259
+ """Search query"""
260
+ query: String!
261
+ """Maximum results to return"""
262
+ limit: Int = 10
263
+ ): [User!]!
264
+ }
265
+
266
+ type Mutation {
267
+ """
268
+ Create a new user account
269
+ """
270
+ createUser(
271
+ """User creation input"""
272
+ input: CreateUserInput!
273
+ ): CreateUserPayload!
274
+ }
275
+
276
+ """
277
+ Input for creating a user
278
+ """
279
+ input CreateUserInput {
280
+ """User's email address"""
281
+ email: String!
282
+ """Display name"""
283
+ name: String!
284
+ }
285
+ ```
286
+
287
+ **GraphQL Playground:**
288
+ ```javascript
289
+ const { ApolloServer } = require('apollo-server');
290
+
291
+ const server = new ApolloServer({
292
+ typeDefs,
293
+ resolvers,
294
+ introspection: true, // Enable in dev
295
+ playground: {
296
+ settings: {
297
+ 'editor.theme': 'dark',
298
+ 'editor.fontSize': 14,
299
+ },
300
+ },
301
+ });
302
+ ```
303
+
304
+ ### WebSocket Protocol Documentation
305
+
306
+ ```yaml
307
+ # AsyncAPI 2.0
308
+ asyncapi: 2.5.0
309
+ info:
310
+ title: Chat WebSocket API
311
+ version: 1.0.0
312
+ description: Real-time chat messaging
313
+
314
+ channels:
315
+ chat/{roomId}:
316
+ parameters:
317
+ roomId:
318
+ description: Chat room identifier
319
+ schema:
320
+ type: string
321
+
322
+ subscribe:
323
+ summary: Receive messages
324
+ message:
325
+ oneOf:
326
+ - $ref: '#/components/messages/ChatMessage'
327
+ - $ref: '#/components/messages/UserJoined'
328
+
329
+ publish:
330
+ summary: Send a message
331
+ message:
332
+ $ref: '#/components/messages/ChatMessage'
333
+
334
+ components:
335
+ messages:
336
+ ChatMessage:
337
+ name: message
338
+ payload:
339
+ type: object
340
+ properties:
341
+ userId:
342
+ type: string
343
+ content:
344
+ type: string
345
+ timestamp:
346
+ type: string
347
+ format: date-time
348
+
349
+ UserJoined:
350
+ name: userJoined
351
+ payload:
352
+ type: object
353
+ properties:
354
+ userId:
355
+ type: string
356
+ username:
357
+ type: string
358
+ ```
359
+
360
+ ### gRPC Documentation
361
+
362
+ ```protobuf
363
+ syntax = "proto3";
364
+
365
+ package users.v1;
366
+
367
+ // User service manages user accounts
368
+ service UserService {
369
+ // Get a user by ID
370
+ // Returns: User object or NOT_FOUND error
371
+ rpc GetUser(GetUserRequest) returns (User) {}
372
+
373
+ // List all users with pagination
374
+ // Returns: Paginated list of users
375
+ rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {}
376
+
377
+ // Create a new user
378
+ // Returns: Created user or ALREADY_EXISTS error
379
+ rpc CreateUser(CreateUserRequest) returns (User) {}
380
+
381
+ // Stream user updates in real-time
382
+ // Returns: Stream of user update events
383
+ rpc WatchUsers(WatchUsersRequest) returns (stream UserEvent) {}
384
+ }
385
+
386
+ // User account
387
+ message User {
388
+ // Unique identifier
389
+ string id = 1;
390
+
391
+ // Email address (unique, required)
392
+ string email = 2;
393
+
394
+ // Display name
395
+ string name = 3;
396
+
397
+ // Account creation timestamp
398
+ google.protobuf.Timestamp created_at = 4;
399
+ }
400
+ ```
401
+
402
+ ## SDK Documentation Strategies
403
+
404
+ ### Multi-Language Examples
405
+
406
+ ```markdown
407
+ # Create User
408
+
409
+ ## Python
410
+ ```python
411
+ from myapi import Client
412
+
413
+ client = Client(api_key="your_key")
414
+ user = client.users.create(
415
+ name="John Doe",
416
+ email="john@example.com"
417
+ )
418
+ print(user.id)
419
+ ```
420
+
421
+ ## TypeScript
422
+ ```typescript
423
+ import { Client } from '@myapi/sdk';
424
+
425
+ const client = new Client({ apiKey: 'your_key' });
426
+ const user = await client.users.create({
427
+ name: 'John Doe',
428
+ email: 'john@example.com',
429
+ });
430
+ console.log(user.id);
431
+ ```
432
+
433
+ ## Go
434
+ ```go
435
+ import "github.com/myapi/sdk-go"
436
+
437
+ client := sdk.NewClient("your_key")
438
+ user, err := client.Users.Create(ctx, &sdk.CreateUserInput{
439
+ Name: "John Doe",
440
+ Email: "john@example.com",
441
+ })
442
+ if err != nil {
443
+ log.Fatal(err)
444
+ }
445
+ fmt.Println(user.ID)
446
+ ```
447
+
448
+ ## Ruby
449
+ ```ruby
450
+ require 'myapi'
451
+
452
+ client = MyAPI::Client.new(api_key: 'your_key')
453
+ user = client.users.create(
454
+ name: 'John Doe',
455
+ email: 'john@example.com'
456
+ )
457
+ puts user.id
458
+ ```
459
+ ```
460
+
461
+ ### SDK Reference Template
462
+
463
+ ```markdown
464
+ # Users SDK
465
+
466
+ ## Installation
467
+ ```bash
468
+ npm install @myapi/sdk
469
+ ```
470
+
471
+ ## Configuration
472
+ ```typescript
473
+ import { Client } from '@myapi/sdk';
474
+
475
+ const client = new Client({
476
+ apiKey: process.env.API_KEY,
477
+ baseUrl: 'https://api.example.com', // Optional
478
+ timeout: 30000, // Optional, default 30s
479
+ });
480
+ ```
481
+
482
+ ## Methods
483
+
484
+ ### `client.users.create(data)`
485
+ Create a new user.
486
+
487
+ **Parameters:**
488
+ - `data.name` (string, required) - User's display name
489
+ - `data.email` (string, required) - User's email address
490
+
491
+ **Returns:** Promise<User>
492
+
493
+ **Throws:**
494
+ - `ValidationError` - Invalid input data
495
+ - `ConflictError` - Email already exists
496
+ - `AuthenticationError` - Invalid API key
497
+
498
+ **Example:**
499
+ ```typescript
500
+ const user = await client.users.create({
501
+ name: 'John Doe',
502
+ email: 'john@example.com',
503
+ });
504
+ ```
505
+
506
+ ## Error Handling
507
+ ```typescript
508
+ import { ValidationError, ConflictError } from '@myapi/sdk';
509
+
510
+ try {
511
+ await client.users.create(data);
512
+ } catch (error) {
513
+ if (error instanceof ValidationError) {
514
+ console.error('Invalid data:', error.fields);
515
+ } else if (error instanceof ConflictError) {
516
+ console.error('User already exists');
517
+ }
518
+ }
519
+ ```
520
+ ```
521
+
522
+ ## Quick Reference
523
+
524
+ | Tool | Protocol | Features |
525
+ |------|----------|----------|
526
+ | Swagger UI | REST | Try-it-out, auth |
527
+ | Redoc | REST | Clean, responsive |
528
+ | Stoplight | REST | Modern, mock server |
529
+ | GraphQL Playground | GraphQL | Explorer, history |
530
+ | AsyncAPI Studio | WebSocket | Visual editor |
531
+ | grpcui | gRPC | Interactive console |