skillfullstack 0.0.0-stage → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.skillsRegistry/catalog.json +231 -0
- package/AGENTS.md +89 -0
- package/README.md +210 -2
- package/bin/index.js +508 -0
- package/package.json +57 -4
- package/skills/backend/apiEngineering/SKILL.md +102 -0
- package/skills/backend/apiEngineering/evals/evalApiEngineering.py +81 -0
- package/skills/backend/apiEngineering/evals/fixtures/invalid/sampleInvalidOpenApi.json +40 -0
- package/skills/backend/apiEngineering/evals/fixtures/valid/sampleValidOpenApi.json +47 -0
- package/skills/backend/apiEngineering/policies/compatibility.md +42 -0
- package/skills/backend/apiEngineering/policies/mandatory.md +48 -0
- package/skills/backend/apiEngineering/policies/performance.md +39 -0
- package/skills/backend/apiEngineering/policies/security.md +36 -0
- package/skills/backend/apiEngineering/references/apiObservability.md +39 -0
- package/skills/backend/apiEngineering/references/apiReference.md +3 -0
- package/skills/backend/apiEngineering/references/apiSecurityOwasp.md +47 -0
- package/skills/backend/apiEngineering/references/contractCompatibility.md +26 -0
- package/skills/backend/apiEngineering/references/databaseTransactions.md +40 -0
- package/skills/backend/apiEngineering/references/distributedReliability.md +26 -0
- package/skills/backend/apiEngineering/references/multiTenancy.md +27 -0
- package/skills/backend/apiEngineering/references/openApi32Standards.md +58 -0
- package/skills/backend/apiEngineering/references/paginationVersioning.md +57 -0
- package/skills/backend/apiEngineering/references/responseStandards.md +94 -0
- package/skills/backend/apiEngineering/scripts/auditApiContract.py +123 -0
- package/skills/backend/apiEngineering/scripts/checkBreakingChanges.py +77 -0
- package/skills/backend/apiEngineering/scripts/generateResponseEnvelope.py +88 -0
- package/skills/backend/apiEngineering/templates/apiChecklist.md +27 -0
- package/skills/backend/apiEngineering/templates/openapi.yaml +125 -0
- package/skills/backend/apiEngineering/templates/problemDetails.json +44 -0
- package/skills/backend/databaseArchitecture/SKILL.md +118 -0
- package/skills/backend/databaseArchitecture/evals/evalDatabaseArchitecture.py +85 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/dangerousMigration.sql +4 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/invalidSchema.sql +23 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/safeMigration.sql +3 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/validSchema.sql +37 -0
- package/skills/backend/databaseArchitecture/policies/integrity.md +25 -0
- package/skills/backend/databaseArchitecture/policies/mandatory.md +32 -0
- package/skills/backend/databaseArchitecture/policies/migration.md +22 -0
- package/skills/backend/databaseArchitecture/policies/normalization.md +25 -0
- package/skills/backend/databaseArchitecture/policies/performance.md +26 -0
- package/skills/backend/databaseArchitecture/policies/recovery.md +23 -0
- package/skills/backend/databaseArchitecture/policies/security.md +26 -0
- package/skills/backend/databaseArchitecture/policies/tableCreationChecklist.md +70 -0
- package/skills/backend/databaseArchitecture/references/analyticsWarehousing.md +32 -0
- package/skills/backend/databaseArchitecture/references/apiReference.md +3 -0
- package/skills/backend/databaseArchitecture/references/backupDisasterRecovery.md +27 -0
- package/skills/backend/databaseArchitecture/references/dataModelingLifecycle.md +30 -0
- package/skills/backend/databaseArchitecture/references/databaseTaxonomy.md +32 -0
- package/skills/backend/databaseArchitecture/references/indexingOptimization.md +32 -0
- package/skills/backend/databaseArchitecture/references/normalizationTheory.md +61 -0
- package/skills/backend/databaseArchitecture/references/scalabilitySharding.md +37 -0
- package/skills/backend/databaseArchitecture/references/transactionConcurrency.md +39 -0
- package/skills/backend/databaseArchitecture/scripts/analyzeMigration.py +99 -0
- package/skills/backend/databaseArchitecture/scripts/auditDatabaseSchema.py +177 -0
- package/skills/backend/databaseArchitecture/scripts/inspectDatabaseIndexes.py +149 -0
- package/skills/backend/databaseArchitecture/templates/adrTemplate.md +32 -0
- package/skills/backend/databaseArchitecture/templates/databaseChecklist.md +29 -0
- package/skills/backend/databaseArchitecture/templates/migrationPlan.md +40 -0
- package/skills/backend/durableBackgroundJobs/SKILL.md +112 -0
- package/skills/backend/durableBackgroundJobs/evals/durableJobVerification.json +14 -0
- package/skills/backend/durableBackgroundJobs/references/apiReference.md +3 -0
- package/skills/backend/durableBackgroundJobs/references/durableStepPatterns.md +6 -0
- package/skills/backend/durableBackgroundJobs/references/idempotencyKeys.md +5 -0
- package/skills/backend/durableBackgroundJobs/scripts/testWorkflowDispatch.py +24 -0
- package/skills/backend/golangStandard/SKILL.md +155 -0
- package/skills/backend/golangStandard/evals/goVerification.json +14 -0
- package/skills/backend/golangStandard/references/apiReference.md +3 -0
- package/skills/backend/golangStandard/references/layoutGuide.md +26 -0
- package/skills/backend/golangStandard/references/slogPatterns.md +26 -0
- package/skills/backend/golangStandard/scripts/scaffoldGoModule.py +105 -0
- package/skills/backend/pythonStandard/SKILL.md +138 -0
- package/skills/backend/pythonStandard/evals/pythonVerification.json +14 -0
- package/skills/backend/pythonStandard/references/apiReference.md +3 -0
- package/skills/backend/pythonStandard/references/pydanticPatterns.md +16 -0
- package/skills/backend/pythonStandard/references/pyprojectSpecs.md +37 -0
- package/skills/backend/pythonStandard/scripts/scaffoldUvProject.py +79 -0
- package/skills/backend/upstash/SKILL.md +98 -0
- package/skills/backend/upstash/evals/upstashVerification.json +14 -0
- package/skills/backend/upstash/references/apiReference.md +3 -0
- package/skills/backend/upstash/references/qstashFlowControl.md +34 -0
- package/skills/backend/upstash/references/ratelimitPatterns.md +53 -0
- package/skills/backend/upstash/references/workflowPatterns.md +35 -0
- package/skills/backend/upstash/scripts/testRedisConnection.py +36 -0
- package/skills/cicdDevops/cicdPipeline/SKILL.md +148 -0
- package/skills/cicdDevops/cicdPipeline/evals/evalCicd.py +37 -0
- package/skills/cicdDevops/cicdPipeline/references/apiReference.md +3 -0
- package/skills/cicdDevops/cicdPipeline/references/cicdDeploymentPatterns.md +27 -0
- package/skills/cicdDevops/cicdPipeline/scripts/auditDockerfileSecurity.py +56 -0
- package/skills/dataAi/mcpServerDevelopment/SKILL.md +123 -0
- package/skills/dataAi/mcpServerDevelopment/evals/mcpVerification.json +14 -0
- package/skills/dataAi/mcpServerDevelopment/references/apiReference.md +3 -0
- package/skills/dataAi/mcpServerDevelopment/references/mcpClientConfigs.md +38 -0
- package/skills/dataAi/mcpServerDevelopment/references/toolSchemaDesign.md +6 -0
- package/skills/dataAi/mcpServerDevelopment/scripts/runFastMcpBoilerplate.py +36 -0
- package/skills/dataAi/ragPipelineProduction/SKILL.md +113 -0
- package/skills/dataAi/ragPipelineProduction/evals/ragVerification.json +14 -0
- package/skills/dataAi/ragPipelineProduction/references/apiReference.md +3 -0
- package/skills/dataAi/ragPipelineProduction/references/chunkingStrategies.md +10 -0
- package/skills/dataAi/ragPipelineProduction/references/rrfAlgorithm.md +13 -0
- package/skills/dataAi/ragPipelineProduction/scripts/runHybridRrfSearch.py +33 -0
- package/skills/devopsCloud/cloudflare/SKILL.md +282 -0
- package/skills/devopsCloud/cloudflare/assets/README.md +48 -0
- package/skills/devopsCloud/cloudflare/assets/ai/agents-sdk.md +118 -0
- package/skills/devopsCloud/cloudflare/assets/ai/ai-gateway.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/ai/ai-search.md +129 -0
- package/skills/devopsCloud/cloudflare/assets/ai/workers-ai.md +127 -0
- package/skills/devopsCloud/cloudflare/assets/cli/c3.md +292 -0
- package/skills/devopsCloud/cloudflare/assets/cli/cf-cli.md +90 -0
- package/skills/devopsCloud/cloudflare/assets/cli/wrangler.md +43 -0
- package/skills/devopsCloud/cloudflare/assets/compute/cron-triggers.md +486 -0
- package/skills/devopsCloud/cloudflare/assets/compute/service-bindings.md +251 -0
- package/skills/devopsCloud/cloudflare/assets/compute/smart-placement.md +435 -0
- package/skills/devopsCloud/cloudflare/assets/compute/static-assets.md +220 -0
- package/skills/devopsCloud/cloudflare/assets/compute/workers.md +129 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/d1.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/durable-objects.md +122 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/hyperdrive.md +210 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/kv.md +198 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/queues.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/r2.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/vectorize.md +97 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/workflows.md +141 -0
- package/skills/devopsCloud/cloudflare/assets/llms.txt +143 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/cache-cdn.md +109 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/dns.md +71 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/rate-limiting.md +130 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/tunnels.md +57 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/waf.md +143 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/1xxx-errors.md +209 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/5xx-errors.md +111 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/http-status-codes.md +38 -0
- package/skills/devopsCloud/cloudflare/evals/evals.json +75 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/README.md +27 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/dynamic-routing.md +15 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/features.md +22 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/sdk-integration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/troubleshooting.md +16 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/README.md +25 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/gotchas.md +13 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/bindings/README.md +16 -0
- package/skills/devopsCloud/cloudflare/references/bindings/api.md +19 -0
- package/skills/devopsCloud/cloudflare/references/bindings/configuration.md +20 -0
- package/skills/devopsCloud/cloudflare/references/bindings/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/bindings/patterns.md +20 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/README.md +18 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/api.md +12 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/configuration.md +12 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/patterns.md +12 -0
- package/skills/devopsCloud/cloudflare/references/cliComparison.md +93 -0
- package/skills/devopsCloud/cloudflare/references/containers/README.md +23 -0
- package/skills/devopsCloud/cloudflare/references/containers/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/containers/configuration.md +15 -0
- package/skills/devopsCloud/cloudflare/references/containers/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/containers/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/README.md +15 -0
- package/skills/devopsCloud/cloudflare/references/d1/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/frameworkCompatibility.md +110 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/README.md +28 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/api.md +26 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/configuration.md +34 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/gotchas.md +20 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/images/README.md +12 -0
- package/skills/devopsCloud/cloudflare/references/images/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/images/configuration.md +17 -0
- package/skills/devopsCloud/cloudflare/references/images/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/images/patterns.md +16 -0
- package/skills/devopsCloud/cloudflare/references/kv/README.md +15 -0
- package/skills/devopsCloud/cloudflare/references/kv/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/kv/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/kv/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/kv/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/patterns.md +19 -0
- package/skills/devopsCloud/cloudflare/references/observability/README.md +27 -0
- package/skills/devopsCloud/cloudflare/references/observability/api.md +20 -0
- package/skills/devopsCloud/cloudflare/references/observability/configuration.md +23 -0
- package/skills/devopsCloud/cloudflare/references/observability/gotchas.md +25 -0
- package/skills/devopsCloud/cloudflare/references/observability/patterns.md +14 -0
- package/skills/devopsCloud/cloudflare/references/pages/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/pages/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/pages/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/pages/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/pages/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/configuration.md +14 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/patterns.md +16 -0
- package/skills/devopsCloud/cloudflare/references/productSelectionMatrix.md +54 -0
- package/skills/devopsCloud/cloudflare/references/queues/README.md +24 -0
- package/skills/devopsCloud/cloudflare/references/queues/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/queues/configuration.md +20 -0
- package/skills/devopsCloud/cloudflare/references/queues/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/queues/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/r2/README.md +26 -0
- package/skills/devopsCloud/cloudflare/references/r2/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/r2/configuration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/r2/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/r2/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/api.md +21 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/configuration.md +25 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/patterns.md +27 -0
- package/skills/devopsCloud/cloudflare/references/skill-feedback.md +41 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/patterns.md +17 -0
- package/skills/devopsCloud/cloudflare/references/stream/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/stream/api-live.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/api.md +21 -0
- package/skills/devopsCloud/cloudflare/references/stream/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/patterns.md +22 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/configuration.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/api.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/configuration.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/networking.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/configuration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/patterns.md +24 -0
- package/skills/devopsCloud/cloudflare/references/waf/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/waf/api.md +17 -0
- package/skills/devopsCloud/cloudflare/references/waf/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/waf/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/waf/patterns.md +17 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/README.md +24 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/patterns.md +14 -0
- package/skills/devopsCloud/cloudflare/references/workflows/README.md +23 -0
- package/skills/devopsCloud/cloudflare/references/workflows/api.md +17 -0
- package/skills/devopsCloud/cloudflare/references/workflows/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/workflows/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/workflows/patterns.md +30 -0
- package/skills/devopsCloud/cloudflare/scripts/auditCloudflareProduction.py +95 -0
- package/skills/foundation/promptEvalTesting/SKILL.md +114 -0
- package/skills/foundation/promptEvalTesting/evals/promptEvalVerification.json +14 -0
- package/skills/foundation/promptEvalTesting/references/apiReference.md +3 -0
- package/skills/foundation/promptEvalTesting/references/evalMetricsCatalog.md +7 -0
- package/skills/foundation/promptEvalTesting/references/promptfooConfigSpecs.md +16 -0
- package/skills/foundation/promptEvalTesting/scripts/runPromptEvalSuite.py +29 -0
- package/skills/frontend/astro/SKILL.md +327 -0
- package/skills/frontend/astro/assets/README.md +71 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/content-collections.md +1061 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/data-fetching.md +109 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/images.md +719 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/markdown.md +725 -0
- package/skills/frontend/astro/assets/build-your-ui/components.md +402 -0
- package/skills/frontend/astro/assets/build-your-ui/fonts.md +437 -0
- package/skills/frontend/astro/assets/build-your-ui/front-end-frameworks.md +245 -0
- package/skills/frontend/astro/assets/build-your-ui/layouts.md +267 -0
- package/skills/frontend/astro/assets/build-your-ui/scripts-and-event-handling.md +229 -0
- package/skills/frontend/astro/assets/build-your-ui/styles-and-css.md +782 -0
- package/skills/frontend/astro/assets/build-your-ui/syntax-highlighting.md +269 -0
- package/skills/frontend/astro/assets/configuration/build-with-ai.md +389 -0
- package/skills/frontend/astro/assets/configuration/configuration-overview.md +122 -0
- package/skills/frontend/astro/assets/configuration/dev-toolbar.md +86 -0
- package/skills/frontend/astro/assets/configuration/editor-setup.md +166 -0
- package/skills/frontend/astro/assets/configuration/environment-variables.md +352 -0
- package/skills/frontend/astro/assets/configuration/typescript.md +379 -0
- package/skills/frontend/astro/assets/configuration/working-with-integrations.md +606 -0
- package/skills/frontend/astro/assets/reference/adapter-reference.md +1242 -0
- package/skills/frontend/astro/assets/reference/cli-reference.md +575 -0
- package/skills/frontend/astro/assets/reference/configuration-reference.md +3144 -0
- package/skills/frontend/astro/assets/reference/content-loader-reference.md +1682 -0
- package/skills/frontend/astro/assets/reference/directives-reference.md +324 -0
- package/skills/frontend/astro/assets/reference/image-service-reference.md +346 -0
- package/skills/frontend/astro/assets/reference/integrations-reference.md +2813 -0
- package/skills/frontend/astro/assets/reference/modules/astro-actions.md +604 -0
- package/skills/frontend/astro/assets/reference/modules/astro-app.md +460 -0
- package/skills/frontend/astro/assets/reference/modules/astro-assets.md +1657 -0
- package/skills/frontend/astro/assets/reference/modules/astro-config.md +395 -0
- package/skills/frontend/astro/assets/reference/modules/astro-content.md +720 -0
- package/skills/frontend/astro/assets/reference/modules/astro-env.md +46 -0
- package/skills/frontend/astro/assets/reference/modules/astro-fetch.md +346 -0
- package/skills/frontend/astro/assets/reference/modules/astro-hono.md +37 -0
- package/skills/frontend/astro/assets/reference/modules/astro-i18n.md +462 -0
- package/skills/frontend/astro/assets/reference/modules/astro-middleware.md +292 -0
- package/skills/frontend/astro/assets/reference/modules/astro-static-paths.md +74 -0
- package/skills/frontend/astro/assets/reference/modules/astro-transitions.md +595 -0
- package/skills/frontend/astro/assets/reference/modules/astro-zod.md +120 -0
- package/skills/frontend/astro/assets/reference/session-driver-reference.md +205 -0
- package/skills/frontend/astro/assets/routing-and-navigation/endpoints.md +251 -0
- package/skills/frontend/astro/assets/routing-and-navigation/internationalization.md +374 -0
- package/skills/frontend/astro/assets/routing-and-navigation/middleware.md +288 -0
- package/skills/frontend/astro/assets/routing-and-navigation/pages.md +205 -0
- package/skills/frontend/astro/assets/routing-and-navigation/prefetch.md +273 -0
- package/skills/frontend/astro/assets/routing-and-navigation/routing.md +760 -0
- package/skills/frontend/astro/assets/routing-and-navigation/view-transitions.md +792 -0
- package/skills/frontend/astro/assets/server-rendering/actions.md +770 -0
- package/skills/frontend/astro/assets/server-rendering/caching.md +255 -0
- package/skills/frontend/astro/assets/server-rendering/on-demand-rendering.md +289 -0
- package/skills/frontend/astro/assets/server-rendering/server-islands.md +126 -0
- package/skills/frontend/astro/assets/server-rendering/sessions.md +270 -0
- package/skills/frontend/astro/assets/start-a-new-project/develop-and-build.md +147 -0
- package/skills/frontend/astro/assets/start-a-new-project/installation.md +342 -0
- package/skills/frontend/astro/assets/start-a-new-project/project-structure.md +137 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/testing.md +412 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/troubleshooting.md +229 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/upgrade-astro.md +205 -0
- package/skills/frontend/astro/assets/welcome/courses.md +46 -0
- package/skills/frontend/astro/assets/welcome/islands-architecture.md +135 -0
- package/skills/frontend/astro/assets/welcome/why-astro.md +90 -0
- package/skills/frontend/astro/evals/evals.json +66 -0
- package/skills/frontend/astro/references/contentCollections.md +164 -0
- package/skills/frontend/astro/references/islandsArchitecture.md +128 -0
- package/skills/frontend/astro/references/serverIslandsAndActions.md +187 -0
- package/skills/frontend/astro/scripts/auditAstroProduction.py +78 -0
- package/skills/frontend/generativeUi/SKILL.md +128 -0
- package/skills/frontend/generativeUi/evals/generativeUiVerification.json +14 -0
- package/skills/frontend/generativeUi/references/apiReference.md +3 -0
- package/skills/frontend/generativeUi/references/clientToolComponentMapping.md +8 -0
- package/skills/frontend/generativeUi/references/dataStreamProtocol.md +10 -0
- package/skills/frontend/generativeUi/scripts/generateUiComponentStub.py +46 -0
- package/skills/frontend/nextjs/SKILL.md +138 -0
- package/skills/frontend/nextjs/assets/README.md +67 -0
- package/skills/frontend/nextjs/assets/api-reference/cli/create-next-app.md +210 -0
- package/skills/frontend/nextjs/assets/api-reference/cli/next.md +484 -0
- package/skills/frontend/nextjs/assets/api-reference/components/font.md +952 -0
- package/skills/frontend/nextjs/assets/api-reference/components/form.md +387 -0
- package/skills/frontend/nextjs/assets/api-reference/components/image.md +1372 -0
- package/skills/frontend/nextjs/assets/api-reference/components/link.md +954 -0
- package/skills/frontend/nextjs/assets/api-reference/components/script.md +421 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-private.md +211 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-remote.md +652 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache.md +848 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-client.md +149 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-server.md +234 -0
- package/skills/frontend/nextjs/assets/api-reference/edge-runtime.md +188 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/default.md +80 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/dynamic-routes.md +417 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/error.md +361 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/forbidden.md +75 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation-client.md +308 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation.md +177 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/intercepting-routes.md +78 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/layout.md +803 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/loading.md +209 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/mdx-components.md +84 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/app-icons.md +302 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/manifest.md +90 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/opengraph-image.md +580 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/robots.md +234 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/sitemap.md +459 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/not-found.md +278 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/page.md +283 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/parallel-routes.md +517 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/proxy.md +857 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/public-folder.md +47 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-groups.md +40 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/dynamicParams.md +40 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/ensureStatic.md +195 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/instant.md +204 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/maxDuration.md +42 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/preferredRegion.md +55 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/prefetch.md +113 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/runtime.md +43 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route.md +772 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/src-folder.md +42 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/template.md +174 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/unauthorized.md +143 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/after.md +332 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cacheLife.md +642 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cacheTag.md +272 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/catchError.md +267 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/connection.md +114 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cookies.md +349 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/draft-mode.md +173 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/fetch.md +141 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/forbidden.md +327 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-image-metadata.md +311 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-metadata.md +1510 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-sitemaps.md +102 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-static-params.md +606 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-viewport.md +347 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/headers.md +92 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/image-response.md +225 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/io.md +131 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/navigation.md +220 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-request.md +116 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-response.md +219 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-root-params.md +479 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/not-found.md +269 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/permanentRedirect.md +92 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/prefetch.md +202 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/redirect.md +255 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/refresh.md +91 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/revalidatePath.md +248 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/revalidateTag.md +175 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unauthorized.md +389 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_cache.md +131 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_noStore.md +61 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_rethrow.md +79 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/updateTag.md +173 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-link-status.md +268 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-offline.md +222 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-params.md +102 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-pathname.md +189 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-report-web-vitals.md +175 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-router.md +214 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-search-params.md +416 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segment.md +214 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segments.md +116 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-server-inserted-html.md +145 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/userAgent.md +95 -0
- package/skills/frontend/nextjs/assets/api-reference/turbopack.md +552 -0
- package/skills/frontend/nextjs/assets/architecture/accessibility.md +47 -0
- package/skills/frontend/nextjs/assets/architecture/fast-refresh.md +122 -0
- package/skills/frontend/nextjs/assets/architecture/nextjs-compiler.md +376 -0
- package/skills/frontend/nextjs/assets/architecture/supported-browsers.md +146 -0
- package/skills/frontend/nextjs/assets/community/contribution-guide.md +459 -0
- package/skills/frontend/nextjs/assets/community/rspack.md +25 -0
- package/skills/frontend/nextjs/assets/getting-started/caching.md +626 -0
- package/skills/frontend/nextjs/assets/getting-started/css.md +336 -0
- package/skills/frontend/nextjs/assets/getting-started/deploying.md +115 -0
- package/skills/frontend/nextjs/assets/getting-started/error-handling.md +485 -0
- package/skills/frontend/nextjs/assets/getting-started/fetching-data.md +743 -0
- package/skills/frontend/nextjs/assets/getting-started/fonts.md +232 -0
- package/skills/frontend/nextjs/assets/getting-started/images.md +272 -0
- package/skills/frontend/nextjs/assets/getting-started/installation.md +446 -0
- package/skills/frontend/nextjs/assets/getting-started/layouts-and-pages.md +386 -0
- package/skills/frontend/nextjs/assets/getting-started/linking-and-navigating.md +475 -0
- package/skills/frontend/nextjs/assets/getting-started/metadata-and-og-images.md +370 -0
- package/skills/frontend/nextjs/assets/getting-started/mutating-data.md +679 -0
- package/skills/frontend/nextjs/assets/getting-started/project-structure.md +290 -0
- package/skills/frontend/nextjs/assets/getting-started/proxy.md +107 -0
- package/skills/frontend/nextjs/assets/getting-started/revalidating.md +241 -0
- package/skills/frontend/nextjs/assets/getting-started/route-handlers.md +233 -0
- package/skills/frontend/nextjs/assets/getting-started/server-and-client-components.md +683 -0
- package/skills/frontend/nextjs/assets/getting-started/upgrading.md +137 -0
- package/skills/frontend/nextjs/assets/glossary.md +315 -0
- package/skills/frontend/nextjs/evals/nextjsVerification.json +14 -0
- package/skills/frontend/nextjs/references/apiReference.md +3 -0
- package/skills/frontend/nextjs/references/dataAccessLayer.md +39 -0
- package/skills/frontend/nextjs/references/nextjsFeatureMap.md +276 -0
- package/skills/frontend/nextjs/references/productionChecklist.md +49 -0
- package/skills/frontend/nextjs/references/securityHeadersCsp.md +44 -0
- package/skills/frontend/nextjs/scripts/auditProductionReadiness.py +85 -0
- package/skills/frontend/shadcn-ui/SKILL.md +102 -0
- package/skills/frontend/shadcn-ui/assets/README.md +82 -0
- package/skills/frontend/shadcn-ui/assets/advanced/javascript.md +44 -0
- package/skills/frontend/shadcn-ui/assets/advanced/monorepo.md +254 -0
- package/skills/frontend/shadcn-ui/assets/advanced/react-19.md +166 -0
- package/skills/frontend/shadcn-ui/assets/advanced/tailwind-v4.md +333 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/chain-of-thought.md +519 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/chat.md +581 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/checkpoint.md +243 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/confirmation.md +382 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/context.md +188 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/file-tree.md +248 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/index.md +307 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/inline-citation.md +219 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/message.md +298 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/model-selector.md +368 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/plan.md +398 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/prompt-input.md +403 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/queue.md +517 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/reasoning.md +349 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/sources.md +303 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/stack-trace.md +514 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/subagent.md +551 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/suggestion.md +246 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/task.md +380 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/terminal.md +463 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/test-results.md +641 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/tool.md +915 -0
- package/skills/frontend/shadcn-ui/assets/components/accordion.md +490 -0
- package/skills/frontend/shadcn-ui/assets/components/alert-dialog.md +520 -0
- package/skills/frontend/shadcn-ui/assets/components/alert.md +351 -0
- package/skills/frontend/shadcn-ui/assets/components/aspect-ratio.md +206 -0
- package/skills/frontend/shadcn-ui/assets/components/attachment.md +715 -0
- package/skills/frontend/shadcn-ui/assets/components/avatar.md +581 -0
- package/skills/frontend/shadcn-ui/assets/components/badge.md +276 -0
- package/skills/frontend/shadcn-ui/assets/components/breadcrumb.md +556 -0
- package/skills/frontend/shadcn-ui/assets/components/bubble.md +706 -0
- package/skills/frontend/shadcn-ui/assets/components/button-group.md +969 -0
- package/skills/frontend/shadcn-ui/assets/components/button.md +523 -0
- package/skills/frontend/shadcn-ui/assets/components/calendar.md +959 -0
- package/skills/frontend/shadcn-ui/assets/components/card.md +684 -0
- package/skills/frontend/shadcn-ui/assets/components/carousel.md +643 -0
- package/skills/frontend/shadcn-ui/assets/components/chart.md +1295 -0
- package/skills/frontend/shadcn-ui/assets/components/checkbox.md +553 -0
- package/skills/frontend/shadcn-ui/assets/components/code-block.md +2041 -0
- package/skills/frontend/shadcn-ui/assets/components/collapsible.md +504 -0
- package/skills/frontend/shadcn-ui/assets/components/combobox.md +1102 -0
- package/skills/frontend/shadcn-ui/assets/components/command.md +682 -0
- package/skills/frontend/shadcn-ui/assets/components/context-menu.md +949 -0
- package/skills/frontend/shadcn-ui/assets/components/data-table.md +1667 -0
- package/skills/frontend/shadcn-ui/assets/components/date-picker.md +698 -0
- package/skills/frontend/shadcn-ui/assets/components/dialog.md +454 -0
- package/skills/frontend/shadcn-ui/assets/components/direction.md +205 -0
- package/skills/frontend/shadcn-ui/assets/components/drawer.md +806 -0
- package/skills/frontend/shadcn-ui/assets/components/dropdown-menu.md +1315 -0
- package/skills/frontend/shadcn-ui/assets/components/empty.md +562 -0
- package/skills/frontend/shadcn-ui/assets/components/field.md +1321 -0
- package/skills/frontend/shadcn-ui/assets/components/hover-card.md +342 -0
- package/skills/frontend/shadcn-ui/assets/components/index.md +82 -0
- package/skills/frontend/shadcn-ui/assets/components/input-group.md +980 -0
- package/skills/frontend/shadcn-ui/assets/components/input-otp.md +551 -0
- package/skills/frontend/shadcn-ui/assets/components/input.md +555 -0
- package/skills/frontend/shadcn-ui/assets/components/item.md +937 -0
- package/skills/frontend/shadcn-ui/assets/components/kbd.md +290 -0
- package/skills/frontend/shadcn-ui/assets/components/label.md +327 -0
- package/skills/frontend/shadcn-ui/assets/components/marker.md +445 -0
- package/skills/frontend/shadcn-ui/assets/components/menubar.md +804 -0
- package/skills/frontend/shadcn-ui/assets/components/message-scroller.md +2770 -0
- package/skills/frontend/shadcn-ui/assets/components/message.md +618 -0
- package/skills/frontend/shadcn-ui/assets/components/native-select.md +321 -0
- package/skills/frontend/shadcn-ui/assets/components/navigation-menu.md +568 -0
- package/skills/frontend/shadcn-ui/assets/components/pagination.md +425 -0
- package/skills/frontend/shadcn-ui/assets/components/popover.md +402 -0
- package/skills/frontend/shadcn-ui/assets/components/progress.md +240 -0
- package/skills/frontend/shadcn-ui/assets/components/questionnaire.md +2055 -0
- package/skills/frontend/shadcn-ui/assets/components/radio-group.md +440 -0
- package/skills/frontend/shadcn-ui/assets/components/resizable.md +302 -0
- package/skills/frontend/shadcn-ui/assets/components/scroll-area.md +226 -0
- package/skills/frontend/shadcn-ui/assets/components/select.md +647 -0
- package/skills/frontend/shadcn-ui/assets/components/separator.md +235 -0
- package/skills/frontend/shadcn-ui/assets/components/sheet.md +354 -0
- package/skills/frontend/shadcn-ui/assets/components/sidebar.md +1156 -0
- package/skills/frontend/shadcn-ui/assets/components/skeleton.md +217 -0
- package/skills/frontend/shadcn-ui/assets/components/slider.md +253 -0
- package/skills/frontend/shadcn-ui/assets/components/spinner.md +352 -0
- package/skills/frontend/shadcn-ui/assets/components/switch.md +296 -0
- package/skills/frontend/shadcn-ui/assets/components/table.md +572 -0
- package/skills/frontend/shadcn-ui/assets/components/tabs.md +425 -0
- package/skills/frontend/shadcn-ui/assets/components/textarea.md +218 -0
- package/skills/frontend/shadcn-ui/assets/components/toast.md +260 -0
- package/skills/frontend/shadcn-ui/assets/components/toggle-group.md +419 -0
- package/skills/frontend/shadcn-ui/assets/components/toggle.md +220 -0
- package/skills/frontend/shadcn-ui/assets/components/tooltip.md +332 -0
- package/skills/frontend/shadcn-ui/assets/components/trace.md +1890 -0
- package/skills/frontend/shadcn-ui/assets/components/typography.md +561 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/next.md +108 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/overview.md +75 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/vite.md +144 -0
- package/skills/frontend/shadcn-ui/assets/forms/next.md +716 -0
- package/skills/frontend/shadcn-ui/assets/forms/overview.md +60 -0
- package/skills/frontend/shadcn-ui/assets/forms/react-hook-form.md +2055 -0
- package/skills/frontend/shadcn-ui/assets/forms/tanstack-form.md +2236 -0
- package/skills/frontend/shadcn-ui/assets/installation/astro.md +252 -0
- package/skills/frontend/shadcn-ui/assets/installation/manual.md +255 -0
- package/skills/frontend/shadcn-ui/assets/installation/next.md +256 -0
- package/skills/frontend/shadcn-ui/assets/installation/react-router.md +226 -0
- package/skills/frontend/shadcn-ui/assets/installation/remix.md +52 -0
- package/skills/frontend/shadcn-ui/assets/installation/vite.md +314 -0
- package/skills/frontend/shadcn-ui/assets/mcp/mcp.md +338 -0
- package/skills/frontend/shadcn-ui/assets/overview/changelog.md +6 -0
- package/skills/frontend/shadcn-ui/assets/overview/cli.md +738 -0
- package/skills/frontend/shadcn-ui/assets/overview/components-json.md +379 -0
- package/skills/frontend/shadcn-ui/assets/overview/directory.md +74 -0
- package/skills/frontend/shadcn-ui/assets/overview/introduction.md +77 -0
- package/skills/frontend/shadcn-ui/assets/overview/skills.md +71 -0
- package/skills/frontend/shadcn-ui/assets/overview/theming.md +304 -0
- package/skills/frontend/shadcn-ui/assets/overview/typeset.md +242 -0
- package/skills/frontend/shadcn-ui/assets/registry/getting-started.md +648 -0
- package/skills/frontend/shadcn-ui/assets/registry/overview.md +90 -0
- package/skills/frontend/shadcn-ui/assets/registry/registry-item-json.md +483 -0
- package/skills/frontend/shadcn-ui/assets/registry/registry-json.md +178 -0
- package/skills/frontend/shadcn-ui/evals/componentVerification.json +19 -0
- package/skills/frontend/shadcn-ui/references/aiComponentsCatalog.md +51 -0
- package/skills/frontend/shadcn-ui/references/apiReference.md +3 -0
- package/skills/frontend/shadcn-ui/references/blocksCatalog.md +32 -0
- package/skills/frontend/shadcn-ui/references/cliCommands.md +47 -0
- package/skills/frontend/shadcn-ui/references/componentMarkdownSources.md +48 -0
- package/skills/frontend/shadcn-ui/scripts/fetchComponentDocs.py +43 -0
- package/skills/frontend/tsxReactStandard/SKILL.md +150 -0
- package/skills/frontend/tsxReactStandard/evals/tsxVerification.json +14 -0
- package/skills/frontend/tsxReactStandard/references/apiReference.md +3 -0
- package/skills/frontend/tsxReactStandard/references/discriminatedUnions.md +31 -0
- package/skills/frontend/tsxReactStandard/references/tsconfigStrict.md +36 -0
- package/skills/frontend/tsxReactStandard/scripts/validateTsxTypes.py +44 -0
- package/skills/gitVersionControl/gitWorkflow/SKILL.md +128 -0
- package/skills/gitVersionControl/gitWorkflow/assets/README.md +23 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-environment.md +87 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-formatting.md +156 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-reference.md +2363 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-git.md +156 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-remote-repositories.md +65 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/associating-text-editors-with-git.md +93 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/caching-your-github-credentials.md +115 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/getting-changes-from-a-remote-repository.md +76 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/ignoring-files.md +51 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/managing-remote-repositories.md +231 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/pushing-commits-to-a-remote-repository.md +119 -0
- package/skills/gitVersionControl/gitWorkflow/evals/evalGitWorkflow.py +43 -0
- package/skills/gitVersionControl/gitWorkflow/references/apiReference.md +3 -0
- package/skills/gitVersionControl/gitWorkflow/references/branchingModels.md +32 -0
- package/skills/gitVersionControl/gitWorkflow/scripts/diagnoseGitGraph.py +68 -0
- package/skills/github/assets/README.md +39 -0
- package/skills/github/assets/cli/gh-environment.md +87 -0
- package/skills/github/assets/cli/gh-formatting.md +156 -0
- package/skills/github/assets/cli/gh-reference.md +2363 -0
- package/skills/github/assets/docs-api/github-docs-api.md +60 -0
- package/skills/github/assets/rest-api/actions-secrets.md +1272 -0
- package/skills/github/assets/rest-api/actions-variables.md +1247 -0
- package/skills/github/assets/rest-api/actions-workflow-runs.md +1697 -0
- package/skills/github/assets/rest-api/actions-workflows.md +348 -0
- package/skills/github/assets/rest-api/authenticating.md +174 -0
- package/skills/github/assets/rest-api/branches.md +727 -0
- package/skills/github/assets/rest-api/checks-runs.md +1013 -0
- package/skills/github/assets/rest-api/checks-suites.md +1142 -0
- package/skills/github/assets/rest-api/code-scanning.md +2957 -0
- package/skills/github/assets/rest-api/collaborators.md +547 -0
- package/skills/github/assets/rest-api/commits.md +957 -0
- package/skills/github/assets/rest-api/dependabot-alerts.md +895 -0
- package/skills/github/assets/rest-api/orgs.md +1172 -0
- package/skills/github/assets/rest-api/overview.md +875 -0
- package/skills/github/assets/rest-api/pull-reviews.md +722 -0
- package/skills/github/assets/rest-api/pulls.md +1605 -0
- package/skills/github/assets/rest-api/quickstart.md +344 -0
- package/skills/github/assets/rest-api/releases.md +650 -0
- package/skills/github/assets/rest-api/repos.md +2957 -0
- package/skills/github/assets/rest-api/rules.md +1507 -0
- package/skills/github/assets/rest-api/secret-scanning.md +947 -0
- package/skills/github/assets/rest-api/teams.md +1690 -0
- package/skills/github/githubAction/SKILL.md +159 -0
- package/skills/github/githubAction/assets/README.md +38 -0
- package/skills/github/githubAction/assets/reference/contexts.md +918 -0
- package/skills/github/githubAction/assets/reference/dependency-caching.md +393 -0
- package/skills/github/githubAction/assets/reference/events-that-trigger-workflows.md +1348 -0
- package/skills/github/githubAction/assets/reference/expressions.md +441 -0
- package/skills/github/githubAction/assets/reference/metadata-syntax.md +803 -0
- package/skills/github/githubAction/assets/reference/variables.md +149 -0
- package/skills/github/githubAction/assets/reference/workflow-cancellation.md +22 -0
- package/skills/github/githubAction/assets/reference/workflow-commands.md +1056 -0
- package/skills/github/githubAction/assets/reference/workflow-syntax.md +1721 -0
- package/skills/github/githubAction/assets/rest-api/secrets.md +1272 -0
- package/skills/github/githubAction/assets/rest-api/workflow-runs.md +1697 -0
- package/skills/github/githubAction/assets/rest-api/workflows.md +348 -0
- package/skills/github/githubAction/assets/starter-workflows/automation/stale.yml +27 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/blank.yml +36 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/docker-image.yml +18 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/go.yml +28 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/maven.yml +35 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/node.js.yml +31 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/python-app.yml +39 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/rust.yml +22 -0
- package/skills/github/githubAction/assets/starter-workflows/code-scanning/codeql.yml +97 -0
- package/skills/github/githubAction/evals/actionVerification.json +14 -0
- package/skills/github/githubAction/references/apiReference.md +3 -0
- package/skills/github/githubAction/references/workflowPatterns.md +81 -0
- package/skills/github/githubAction/scripts/validateWorkflowYaml.py +53 -0
- package/skills/github/githubQuality/SKILL.md +136 -0
- package/skills/github/githubQuality/assets/README.md +24 -0
- package/skills/github/githubQuality/assets/pull-requests/about-code-owners.md +178 -0
- package/skills/github/githubQuality/assets/pull-requests/about-merge-methods.md +48 -0
- package/skills/github/githubQuality/assets/pull-requests/creating-a-pull-request.md +170 -0
- package/skills/github/githubQuality/assets/pull-requests/giving-reviews.md +48 -0
- package/skills/github/githubQuality/assets/pull-requests/managing-a-merge-queue.md +134 -0
- package/skills/github/githubQuality/assets/pull-requests/merging-a-pull-request.md +101 -0
- package/skills/github/githubQuality/assets/pull-requests/resolving-reviews.md +59 -0
- package/skills/github/githubQuality/assets/pull-requests/status-checks.md +135 -0
- package/skills/github/githubQuality/assets/rest-api/checks-runs.md +1013 -0
- package/skills/github/githubQuality/assets/rest-api/checks-suites.md +1142 -0
- package/skills/github/githubQuality/assets/rest-api/commits.md +957 -0
- package/skills/github/githubQuality/assets/rest-api/pulls.md +1605 -0
- package/skills/github/githubQuality/assets/rest-api/reviews.md +722 -0
- package/skills/github/githubQuality/evals/qualityVerification.json +14 -0
- package/skills/github/githubQuality/references/apiReference.md +3 -0
- package/skills/github/githubQuality/references/codeownersExample.md +26 -0
- package/skills/github/githubQuality/references/prTemplate.md +20 -0
- package/skills/github/githubQuality/scripts/auditPrQuality.py +52 -0
- package/skills/github/githubSecurity/SKILL.md +170 -0
- package/skills/github/githubSecurity/assets/README.md +32 -0
- package/skills/github/githubSecurity/assets/code-scanning/code-scanning-alerts.md +133 -0
- package/skills/github/githubSecurity/assets/code-scanning/code-scanning.md +67 -0
- package/skills/github/githubSecurity/assets/code-scanning/codeql-code-scanning.md +79 -0
- package/skills/github/githubSecurity/assets/code-scanning/configure-code-scanning.md +121 -0
- package/skills/github/githubSecurity/assets/dependabot/about-the-dependabot-yml-file.md +74 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-alerts.md +133 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-security-updates.md +95 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-version-updates.md +80 -0
- package/skills/github/githubSecurity/assets/rest-api/code-scanning.md +2957 -0
- package/skills/github/githubSecurity/assets/rest-api/dependabot-alerts.md +895 -0
- package/skills/github/githubSecurity/assets/rest-api/secret-scanning.md +947 -0
- package/skills/github/githubSecurity/assets/secret-scanning/enable-secret-scanning.md +59 -0
- package/skills/github/githubSecurity/assets/secret-scanning/secret-scanning.md +105 -0
- package/skills/github/githubSecurity/assets/security-advisories/github-advisory-database.md +148 -0
- package/skills/github/githubSecurity/evals/securityVerification.json +14 -0
- package/skills/github/githubSecurity/references/apiReference.md +3 -0
- package/skills/github/githubSecurity/references/codeqlAnalysis.yml +42 -0
- package/skills/github/githubSecurity/references/dependabotConfig.yml +27 -0
- package/skills/github/githubSecurity/scripts/auditRepoSecurity.py +47 -0
- package/skills/github/githubSetup/SKILL.md +137 -0
- package/skills/github/githubSetup/assets/README.md +40 -0
- package/skills/github/githubSetup/assets/branches/about-protected-branches.md +198 -0
- package/skills/github/githubSetup/assets/branches/changing-the-default-branch.md +49 -0
- package/skills/github/githubSetup/assets/branches/deleting-and-restoring-branches.md +44 -0
- package/skills/github/githubSetup/assets/branches/managing-a-branch-protection-rule.md +115 -0
- package/skills/github/githubSetup/assets/branches/renaming-a-branch.md +74 -0
- package/skills/github/githubSetup/assets/branches/viewing-branches-in-your-repository.md +30 -0
- package/skills/github/githubSetup/assets/repositories/about-repositories.md +127 -0
- package/skills/github/githubSetup/assets/repositories/cloning-a-repository.md +114 -0
- package/skills/github/githubSetup/assets/repositories/creating-a-new-repository.md +82 -0
- package/skills/github/githubSetup/assets/repositories/creating-a-repository-from-a-template.md +51 -0
- package/skills/github/githubSetup/assets/repositories/deleting-a-repository.md +34 -0
- package/skills/github/githubSetup/assets/repositories/managing-teams-and-people-with-access.md +69 -0
- package/skills/github/githubSetup/assets/repositories/renaming-a-repository.md +47 -0
- package/skills/github/githubSetup/assets/repositories/restoring-a-deleted-repository.md +61 -0
- package/skills/github/githubSetup/assets/repositories/setting-repository-visibility.md +137 -0
- package/skills/github/githubSetup/assets/rest-api/branches.md +727 -0
- package/skills/github/githubSetup/assets/rest-api/quickstart.md +344 -0
- package/skills/github/githubSetup/assets/rest-api/repos.md +2957 -0
- package/skills/github/githubSetup/assets/rulesets/about-rulesets.md +72 -0
- package/skills/github/githubSetup/assets/rulesets/available-rules-for-rulesets.md +383 -0
- package/skills/github/githubSetup/assets/rulesets/converting-branch-protections-to-rulesets.md +92 -0
- package/skills/github/githubSetup/assets/rulesets/creating-rulesets-for-a-repository.md +108 -0
- package/skills/github/githubSetup/assets/rulesets/managing-rulesets-for-a-repository.md +149 -0
- package/skills/github/githubSetup/assets/rulesets/troubleshooting-rules.md +122 -0
- package/skills/github/githubSetup/evals/setupVerification.json +14 -0
- package/skills/github/githubSetup/references/apiReference.md +3 -0
- package/skills/github/githubSetup/references/repoSettingsBlueprint.md +13 -0
- package/skills/github/githubSetup/references/rulesetTemplates.json +42 -0
- package/skills/github/githubSetup/scripts/configureRepoBaseline.py +46 -0
- package/skills/github/githubTeam/SKILL.md +115 -0
- package/skills/github/githubTeam/assets/README.md +21 -0
- package/skills/github/githubTeam/assets/organizations/about-organizations.md +69 -0
- package/skills/github/githubTeam/assets/organizations/repository-roles-for-an-organization.md +94 -0
- package/skills/github/githubTeam/assets/rest-api/collaborators.md +547 -0
- package/skills/github/githubTeam/assets/rest-api/orgs.md +1172 -0
- package/skills/github/githubTeam/assets/rest-api/teams.md +1690 -0
- package/skills/github/githubTeam/assets/teams/about-teams.md +82 -0
- package/skills/github/githubTeam/assets/teams/adding-members-to-a-team.md +55 -0
- package/skills/github/githubTeam/evals/teamVerification.json +14 -0
- package/skills/github/githubTeam/references/apiReference.md +3 -0
- package/skills/github/githubTeam/references/permissionMatrix.md +17 -0
- package/skills/github/githubTeam/references/reviewAssignment.md +17 -0
- package/skills/github/githubTeam/scripts/manageTeamSync.py +31 -0
- package/skills/securityQa/llmSecurityRedteaming/SKILL.md +86 -0
- package/skills/securityQa/llmSecurityRedteaming/evals/securityRedteamVerification.json +14 -0
- package/skills/securityQa/llmSecurityRedteaming/references/apiReference.md +3 -0
- package/skills/securityQa/llmSecurityRedteaming/references/jailbreakTaxonomy.md +6 -0
- package/skills/securityQa/llmSecurityRedteaming/references/owaspLlmTopTen.md +12 -0
- package/skills/securityQa/llmSecurityRedteaming/scripts/testPromptInjection.py +34 -0
- package/skills/softwareDevelopment/requirementsEngineering/SKILL.md +110 -0
- package/skills/softwareDevelopment/requirementsEngineering/evals/evalRequirements.py +33 -0
- package/skills/softwareDevelopment/requirementsEngineering/references/apiReference.md +3 -0
- package/skills/softwareDevelopment/requirementsEngineering/references/requirementsAnalysisModels.md +34 -0
- package/skills/softwareDevelopment/requirementsEngineering/scripts/validateUserStories.py +49 -0
- package/skills/testing/testDrivenDevelopment/SKILL.md +122 -0
- package/skills/testing/testDrivenDevelopment/evals/evalTdd.py +25 -0
- package/skills/testing/testDrivenDevelopment/references/apiReference.md +3 -0
- package/skills/testing/testDrivenDevelopment/references/testPyramidDoubles.md +35 -0
- package/skills/testing/testDrivenDevelopment/scripts/auditTestPyramid.py +58 -0
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""
|
|
3
|
+
evalApiEngineering.py
|
|
4
|
+
Evaluates the scripts and compliance checkers in apiEngineering:
|
|
5
|
+
- auditApiContract.py (valid & invalid fixtures)
|
|
6
|
+
- generateResponseEnvelope.py (TS & Python generation)
|
|
7
|
+
- checkBreakingChanges.py (breaking change detection)
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
import subprocess
|
|
11
|
+
import json
|
|
12
|
+
import os
|
|
13
|
+
import sys
|
|
14
|
+
import tempfile
|
|
15
|
+
|
|
16
|
+
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
|
|
17
|
+
SCRIPTS_DIR = os.path.join(BASE_DIR, "..", "scripts")
|
|
18
|
+
FIXTURES_DIR = os.path.join(BASE_DIR, "fixtures")
|
|
19
|
+
|
|
20
|
+
def test_audit_valid_fixture():
|
|
21
|
+
valid_spec = os.path.join(FIXTURES_DIR, "valid", "sampleValidOpenApi.json")
|
|
22
|
+
script = os.path.join(SCRIPTS_DIR, "auditApiContract.py")
|
|
23
|
+
res = subprocess.run([sys.executable, script, "--spec", valid_spec], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
|
|
24
|
+
assert res.returncode == 0, f"Expected 0 for valid fixture, got {res.returncode}: {res.stderr}"
|
|
25
|
+
data = json.loads(res.stdout)
|
|
26
|
+
assert data["isCompliant"] is True
|
|
27
|
+
print(" test_audit_valid_fixture passed")
|
|
28
|
+
|
|
29
|
+
def test_audit_invalid_fixture():
|
|
30
|
+
invalid_spec = os.path.join(FIXTURES_DIR, "invalid", "sampleInvalidOpenApi.json")
|
|
31
|
+
script = os.path.join(SCRIPTS_DIR, "auditApiContract.py")
|
|
32
|
+
res = subprocess.run([sys.executable, script, "--spec", invalid_spec], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
|
|
33
|
+
assert res.returncode == 1, "Expected 1 for invalid fixture"
|
|
34
|
+
data = json.loads(res.stdout)
|
|
35
|
+
assert data["isCompliant"] is False
|
|
36
|
+
assert any("application/problem+json" in f["message"] for f in data["findings"])
|
|
37
|
+
print(" test_audit_invalid_fixture passed")
|
|
38
|
+
|
|
39
|
+
def test_generate_envelope():
|
|
40
|
+
script = os.path.join(SCRIPTS_DIR, "generateResponseEnvelope.py")
|
|
41
|
+
|
|
42
|
+
# Test TypeScript
|
|
43
|
+
res_ts = subprocess.run([sys.executable, script, "--lang", "ts"], stdout=subprocess.PIPE, text=True, check=True)
|
|
44
|
+
assert "export interface ApiResponse<T>" in res_ts.stdout
|
|
45
|
+
assert "export interface ProblemDetails" in res_ts.stdout
|
|
46
|
+
|
|
47
|
+
# Test Python
|
|
48
|
+
res_py = subprocess.run([sys.executable, script, "--lang", "py"], stdout=subprocess.PIPE, text=True, check=True)
|
|
49
|
+
assert "class ApiResponse(BaseModel, Generic[T]):" in res_py.stdout
|
|
50
|
+
assert "class ProblemDetails(BaseModel):" in res_py.stdout
|
|
51
|
+
print(" test_generate_envelope passed")
|
|
52
|
+
|
|
53
|
+
def test_check_breaking_changes():
|
|
54
|
+
script = os.path.join(SCRIPTS_DIR, "checkBreakingChanges.py")
|
|
55
|
+
valid_spec = os.path.join(FIXTURES_DIR, "valid", "sampleValidOpenApi.json")
|
|
56
|
+
|
|
57
|
+
# Identical specs -> no breaking changes
|
|
58
|
+
res_same = subprocess.run([sys.executable, script, "--old", valid_spec, "--new", valid_spec], stdout=subprocess.PIPE, text=True)
|
|
59
|
+
assert res_same.returncode == 0
|
|
60
|
+
data_same = json.loads(res_same.stdout)
|
|
61
|
+
assert data_same["hasBreakingChanges"] is False
|
|
62
|
+
|
|
63
|
+
# Modified spec removing an endpoint
|
|
64
|
+
with tempfile.NamedTemporaryFile("w+", suffix=".json") as tmp:
|
|
65
|
+
modified = {"openapi": "3.2.1", "paths": {}}
|
|
66
|
+
json.dump(modified, tmp)
|
|
67
|
+
tmp.flush()
|
|
68
|
+
res_diff = subprocess.run([sys.executable, script, "--old", valid_spec, "--new", tmp.name], stdout=subprocess.PIPE, text=True)
|
|
69
|
+
assert res_diff.returncode == 1
|
|
70
|
+
data_diff = json.loads(res_diff.stdout)
|
|
71
|
+
assert data_diff["hasBreakingChanges"] is True
|
|
72
|
+
assert any("Removed endpoint" in b for b in data_diff["breakingChanges"])
|
|
73
|
+
|
|
74
|
+
print(" test_check_breaking_changes passed")
|
|
75
|
+
|
|
76
|
+
if __name__ == "__main__":
|
|
77
|
+
test_audit_valid_fixture()
|
|
78
|
+
test_audit_invalid_fixture()
|
|
79
|
+
test_generate_envelope()
|
|
80
|
+
test_check_breaking_changes()
|
|
81
|
+
print("All apiEngineering evals passed successfully!")
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Invalid Legacy API",
|
|
5
|
+
"version": "1.0.0"
|
|
6
|
+
},
|
|
7
|
+
"paths": {
|
|
8
|
+
"/v1/customers": {
|
|
9
|
+
"get": {
|
|
10
|
+
"summary": "List customers with unbounded limits and generic json errors",
|
|
11
|
+
"parameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "limit",
|
|
14
|
+
"in": "query",
|
|
15
|
+
"required": false,
|
|
16
|
+
"schema": {
|
|
17
|
+
"type": "integer",
|
|
18
|
+
"maximum": 5000
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
],
|
|
22
|
+
"responses": {
|
|
23
|
+
"200": {
|
|
24
|
+
"description": "OK"
|
|
25
|
+
},
|
|
26
|
+
"422": {
|
|
27
|
+
"description": "Validation error",
|
|
28
|
+
"content": {
|
|
29
|
+
"application/json": {
|
|
30
|
+
"schema": {
|
|
31
|
+
"type": "object"
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.2.1",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Valid Customer API",
|
|
5
|
+
"version": "1.0.0"
|
|
6
|
+
},
|
|
7
|
+
"paths": {
|
|
8
|
+
"/v1/customers": {
|
|
9
|
+
"get": {
|
|
10
|
+
"summary": "List customers",
|
|
11
|
+
"parameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "limit",
|
|
14
|
+
"in": "query",
|
|
15
|
+
"required": false,
|
|
16
|
+
"schema": {
|
|
17
|
+
"type": "integer",
|
|
18
|
+
"maximum": 50
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
],
|
|
22
|
+
"responses": {
|
|
23
|
+
"200": {
|
|
24
|
+
"description": "Customer list",
|
|
25
|
+
"content": {
|
|
26
|
+
"application/json": {
|
|
27
|
+
"schema": {
|
|
28
|
+
"type": "object"
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"422": {
|
|
34
|
+
"description": "Validation error",
|
|
35
|
+
"content": {
|
|
36
|
+
"application/problem+json": {
|
|
37
|
+
"schema": {
|
|
38
|
+
"type": "object"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# API Versioning & Compatibility Policies
|
|
2
|
+
|
|
3
|
+
All API modifications must preserve consumer stability and backward compatibility.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. The Additive Law of API Changes
|
|
8
|
+
|
|
9
|
+
The following changes are **NON-BREAKING** (Allowed on existing major versions):
|
|
10
|
+
- Adding new optional request query parameters or request body fields.
|
|
11
|
+
- Adding new fields to response representations.
|
|
12
|
+
- Adding a new endpoint or HTTP method to an existing resource.
|
|
13
|
+
- Adding new error codes within the existing RFC 9457 structure.
|
|
14
|
+
|
|
15
|
+
The following changes are **BREAKING** (Forbidden on existing major versions):
|
|
16
|
+
- Removing an existing endpoint or HTTP method.
|
|
17
|
+
- Renaming or removing existing fields in response payloads.
|
|
18
|
+
- Changing the data type of an existing field (e.g. integer to string).
|
|
19
|
+
- Adding new required request headers, query parameters, or body properties.
|
|
20
|
+
- Changing semantic meaning or status code of an existing response.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 2. Deprecation Signaling Protocol
|
|
25
|
+
|
|
26
|
+
When an endpoint or field is deprecated, it must signal deprecation using exact standards:
|
|
27
|
+
- **`Deprecation` Header (RFC 9745)**:
|
|
28
|
+
Uses an RFC 9651 Structured Field Date:
|
|
29
|
+
```http
|
|
30
|
+
Deprecation: @1794787200
|
|
31
|
+
```
|
|
32
|
+
- **`Sunset` Header (RFC 8594)**:
|
|
33
|
+
Uses an HTTP-date format specifying when the endpoint will be turned off:
|
|
34
|
+
```http
|
|
35
|
+
Sunset: Tue, 17 Nov 2026 00:00:00 GMT
|
|
36
|
+
```
|
|
37
|
+
- **`Link` Header**:
|
|
38
|
+
Points to migration documentation:
|
|
39
|
+
```http
|
|
40
|
+
Link: <https://api.example.com/docs/migrations/v2>; rel="deprecation"
|
|
41
|
+
```
|
|
42
|
+
- **Minimum Notice Window**: Deprecated endpoints must remain operational for a minimum of 180 days before removal.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Mandatory API Engineering Policies
|
|
2
|
+
|
|
3
|
+
These policies are non-negotiable requirements for all APIs created or maintained under the API Engineering System.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Architectural Boundaries
|
|
8
|
+
|
|
9
|
+
- **Separation of Concerns**:
|
|
10
|
+
- `Transport Layer (Controllers/Routes)`: Only parse HTTP request headers, query parameters, body, validate DTO schemas, and map results to HTTP status codes.
|
|
11
|
+
- `Domain Service Layer`: Encapsulates pure business logic, calculations, invariants, and authorization rules.
|
|
12
|
+
- `Persistence Layer (Repositories)`: Encapsulates database queries, ORM calls, and transactional boundaries.
|
|
13
|
+
- **DTO Isolation**:
|
|
14
|
+
- Database models/entities must NEVER be returned directly in API responses.
|
|
15
|
+
- Request DTOs and Response DTOs must be explicitly defined separate types.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 2. HTTP Protocol Semantics
|
|
20
|
+
|
|
21
|
+
- **Status Code Precision**:
|
|
22
|
+
- `200 OK`: Successful read or synchronous update returning representation.
|
|
23
|
+
- `201 Created`: Resource created. MUST include `Location: /v1/<resource>/<id>` header.
|
|
24
|
+
- `202 Accepted`: Long-running asynchronous request queued.
|
|
25
|
+
- `204 No Content`: Successful deletion or action returning no body. MUST NOT include response body.
|
|
26
|
+
- `304 Not Modified`: ETag / conditional request validation match.
|
|
27
|
+
- `400 Bad Request`: Generic malformed syntax (missing required header, malformed JSON).
|
|
28
|
+
- `401 Unauthorized`: Missing, expired, or invalid authentication credentials.
|
|
29
|
+
- `403 Forbidden`: Authenticated caller lacks permission for the resource.
|
|
30
|
+
- `404 Not Found`: Resource does not exist or caller should not know it exists.
|
|
31
|
+
- `409 Conflict`: Request conflicts with current server state (duplicate unique key, concurrent idempotency lock, optimistic lock failure).
|
|
32
|
+
- `422 Unprocessable Content`: Semantically invalid request payload (validation errors, idempotency payload mismatch).
|
|
33
|
+
- `429 Too Many Requests`: Rate limit exhausted. MUST include `Retry-After` header.
|
|
34
|
+
- `500 Internal Server Error`: Unhandled crash. MUST NOT expose stack traces or DB errors to caller.
|
|
35
|
+
- `502 Bad Gateway` / `503 Service Unavailable` / `504 Gateway Timeout`: Upstream dependency failure.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 3. Response Contract Format
|
|
40
|
+
|
|
41
|
+
- **Success Envelope**:
|
|
42
|
+
```json
|
|
43
|
+
{
|
|
44
|
+
"data": { ... },
|
|
45
|
+
"meta": { ... }
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
- **Error Format**: Strictly RFC 9457 `application/problem+json` content-type.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# API Performance & Scalability Policies
|
|
2
|
+
|
|
3
|
+
All API implementations must enforce resource boundaries and operational scalability policies.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Resource Boundaries & Query Safeguards
|
|
8
|
+
|
|
9
|
+
- **Mandatory Collection Pagination**:
|
|
10
|
+
- Every collection endpoint must enforce pagination.
|
|
11
|
+
- Default page size: `20` items.
|
|
12
|
+
- Absolute maximum ceiling: `100` items (`limit <= 100`). Requests exceeding the maximum must be clamped or rejected with `422`.
|
|
13
|
+
- **Database Index Alignment**:
|
|
14
|
+
- Every filtered or sorted query parameter must map to a database index.
|
|
15
|
+
- Sorting must be deterministic: always tie-break with a unique indexed column (e.g., `ORDER BY created_at DESC, id DESC`).
|
|
16
|
+
- **Connection Pool Sizing**:
|
|
17
|
+
- Set explicit pool boundaries (`min_connections`, `max_connections`) and connection acquisition timeouts ($\le 3$ seconds) to prevent cascading thread starvation.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 2. Caching & HTTP Conditional Requests
|
|
22
|
+
|
|
23
|
+
- **ETags & Validation**:
|
|
24
|
+
- Read-heavy resources should return strong ETags (`ETag: "hash"`) and support conditional requests (`If-None-Match`).
|
|
25
|
+
- Cacheable GET responses must return `Cache-Control: private, max-age=...` or `no-cache, must-revalidate`.
|
|
26
|
+
- **Rate Limiting**:
|
|
27
|
+
- Standard rate limit headers must accompany responses:
|
|
28
|
+
- `RateLimit-Limit`: Maximum allowed requests per time window.
|
|
29
|
+
- `RateLimit-Remaining`: Remaining request quota.
|
|
30
|
+
- `RateLimit-Reset`: Seconds until window resets.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 3. Idempotency & Safe Mutation Retries
|
|
35
|
+
|
|
36
|
+
- State-mutating endpoints (`POST /payments`, `POST /orders`, `POST /transfers`) must enforce the `Idempotency-Key` header (IETF Internet-Draft `idempotency-key-08`).
|
|
37
|
+
- Key retention TTL: Minimum 24 hours.
|
|
38
|
+
- In-flight lock: Reject concurrent identical keys with `409 Conflict`.
|
|
39
|
+
- Fingerprint verification: Reject mismatched payloads using identical keys with `422 Unprocessable Content`.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# API Security Policies (OWASP API Top 10 Enforced)
|
|
2
|
+
|
|
3
|
+
All API implementations must adhere to these enforceable security policies.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Authorization & Access Control
|
|
8
|
+
|
|
9
|
+
- **BOLA Protection (API1:2023)**:
|
|
10
|
+
- Every endpoint accepting an object identifier (e.g. `/v1/invoices/{id}`) must scope database lookups to the authenticated user's tenant or account ID:
|
|
11
|
+
```sql
|
|
12
|
+
-- Compliant:
|
|
13
|
+
SELECT * FROM invoices WHERE id = :id AND tenant_id = :auth_tenant_id;
|
|
14
|
+
-- Non-Compliant (BOLA Vulnerability):
|
|
15
|
+
SELECT * FROM invoices WHERE id = :id;
|
|
16
|
+
```
|
|
17
|
+
- **BOPLA & Mass Assignment (API3:2023)**:
|
|
18
|
+
- Request DTOs must use strict allowlisting. Unrecognized properties must be stripped or rejected with `422`.
|
|
19
|
+
- Properties such as `role`, `is_admin`, `verified`, or `tenant_id` must NEVER be bindable from client requests.
|
|
20
|
+
- **BFLA (API5:2023)**:
|
|
21
|
+
- Administrative routes must enforce explicit role assertions at the controller gateway or middleware, never relying on UI invisibility.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 2. Authentication & Credential Safety
|
|
26
|
+
|
|
27
|
+
- Short-lived access tokens ($\le 15$ minutes) paired with rotating refresh tokens stored in `HttpOnly`, `Secure`, `SameSite=Strict` cookies.
|
|
28
|
+
- Sensitive credentials, API keys, or JWT tokens must NEVER be accepted in query strings (`?token=...`). Use `Authorization: Bearer <token>`.
|
|
29
|
+
- Passwords must be hashed using Argon2id or bcrypt (cost factor $\ge 12$).
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 3. Input Sanitization & SSRF Defense
|
|
34
|
+
|
|
35
|
+
- Outbound webhooks or external HTTP requests (API7:2023) must parse and validate target hostnames against an allowlist, strictly blocking loopback (`127.0.0.1`, `localhost`) and cloud metadata IPs (`169.254.169.254`).
|
|
36
|
+
- SQL queries must exclusively use parameterized queries or type-safe query builders. Raw string concatenation is forbidden.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# API Observability: Logs, Metrics & Distributed Tracing Reference
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## 1. Structured JSON Logging
|
|
6
|
+
|
|
7
|
+
Every API log entry must be structured JSON and include standard correlation keys:
|
|
8
|
+
```json
|
|
9
|
+
{
|
|
10
|
+
"timestamp": "2026-11-16T12:00:00.123Z",
|
|
11
|
+
"level": "INFO",
|
|
12
|
+
"traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
|
|
13
|
+
"spanId": "00f067aa0ba902b7",
|
|
14
|
+
"http": {
|
|
15
|
+
"method": "POST",
|
|
16
|
+
"route": "/v1/invoices",
|
|
17
|
+
"status": 201,
|
|
18
|
+
"durationMs": 42
|
|
19
|
+
},
|
|
20
|
+
"tenantId": "ten_01HX9...",
|
|
21
|
+
"userId": "usr_01HX9..."
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
*Law*: Never log sensitive credentials, passwords, raw authorization headers, or full credit card numbers.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 2. The RED Method for API Metrics
|
|
29
|
+
|
|
30
|
+
Track three golden signals on every endpoint:
|
|
31
|
+
- **Rate**: Invocations per second (`requests_total{route="/v1/users", status="200"}`).
|
|
32
|
+
- **Errors**: Number of 5xx server errors and unhandled exceptions.
|
|
33
|
+
- **Duration**: Latency histogram distribution (track p50, p95, p99).
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 3. Distributed Tracing (OpenTelemetry)
|
|
38
|
+
|
|
39
|
+
Propagate `traceparent` headers across microservices according to W3C Trace Context specifications (`traceparent: 00-4bf9...-00f0...-01`).
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# OWASP API Security Top 10 (2023 / 2026) Deep Reference
|
|
2
|
+
|
|
3
|
+
Comprehensive threat defense checklist across all 10 vectors.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## The 10 Vectors & Engineering Mitigations
|
|
8
|
+
|
|
9
|
+
### 1. API1:2023 - Broken Object Level Authorization (BOLA)
|
|
10
|
+
- **Threat**: Attacker changes resource ID in URL to access unauthorized data.
|
|
11
|
+
- **Defense**: Always enforce tenant/user context in the SQL WHERE clause or repository call. Never trust client IDs.
|
|
12
|
+
|
|
13
|
+
### 2. API2:2023 - Broken Authentication
|
|
14
|
+
- **Threat**: Weak password policies, token leakage in URLs, flawed JWT signature verification.
|
|
15
|
+
- **Defense**: Asymmetric token signing (RS256/EdDSA), 15-minute token TTL, no credentials in query strings.
|
|
16
|
+
|
|
17
|
+
### 3. API3:2023 - Broken Object Property Level Authorization (BOPLA)
|
|
18
|
+
- **Threat**: Mass assignment where client submits internal fields (`is_admin`, `verified`, `credit_balance`).
|
|
19
|
+
- **Defense**: Strict DTO allowlisting. Reject or ignore non-permitted fields. Never bind raw JSON directly into ORM entities.
|
|
20
|
+
|
|
21
|
+
### 4. API4:2023 - Unrestricted Resource Consumption
|
|
22
|
+
- **Threat**: DoS via huge payload uploads, unbounded database queries, or regex exponential backtracking.
|
|
23
|
+
- **Defense**: Mandatory `limit <= 100` on collections, request body size limits (`1MB` default), rate limiting.
|
|
24
|
+
|
|
25
|
+
### 5. API5:2023 - Broken Function Level Authorization (BFLA)
|
|
26
|
+
- **Threat**: Standard user invokes administrative endpoints (e.g. `POST /v1/users/{id}/ban`).
|
|
27
|
+
- **Defense**: Role and scope verification at middleware entry point before handler execution.
|
|
28
|
+
|
|
29
|
+
### 6. API6:2023 - Unrestricted Access to Sensitive Business Flows
|
|
30
|
+
- **Threat**: Automated scalping bots, credential stuffing, fake account bulk creation.
|
|
31
|
+
- **Defense**: Progressive delays, CAPTCHA on sensitive flows, device risk scoring.
|
|
32
|
+
|
|
33
|
+
### 7. API7:2023 - Server Side Request Forgery (SSRF)
|
|
34
|
+
- **Threat**: Attacker inputs `http://169.254.169.254/latest/meta-data` as webhook URL to exfiltrate cloud credentials.
|
|
35
|
+
- **Defense**: IP resolution check blocking RFC 1918 private IPs, loopback, and cloud metadata endpoints.
|
|
36
|
+
|
|
37
|
+
### 8. API8:2023 - Security Misconfiguration
|
|
38
|
+
- **Threat**: Verbose error stack traces, unpatched dependencies, overly permissive CORS (`Access-Control-Allow-Origin: *` with credentials).
|
|
39
|
+
- **Defense**: Generic RFC 9457 errors in production, hardened TLS (TLS 1.3), specific CORS origin allowlists.
|
|
40
|
+
|
|
41
|
+
### 9. API9:2023 - Improper Inventory Management
|
|
42
|
+
- **Threat**: Old API versions (`/v1`) running unpatched while `/v2` is secured.
|
|
43
|
+
- **Defense**: Maintain central OpenAPI inventory, automated deprecation header emission (RFC 9745), and decommissioned route gating.
|
|
44
|
+
|
|
45
|
+
### 10. API10:2023 - Unsafe Consumption of APIs
|
|
46
|
+
- **Threat**: Blindly trusting third-party API payloads leading to SQLi or command injection.
|
|
47
|
+
- **Defense**: Validate all inbound payloads from third parties against strict JSON schemas with timeouts.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# API Contract Compatibility & Breaking Change Detection Reference
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## 1. Classification of API Changes
|
|
6
|
+
|
|
7
|
+
| Change Type | Classification | CI Action |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
| **Add optional query parameter** | Non-Breaking | PASS |
|
|
10
|
+
| **Add field to response object** | Non-Breaking | PASS |
|
|
11
|
+
| **Add new endpoint** | Non-Breaking | PASS |
|
|
12
|
+
| **Remove endpoint** | **Breaking** | **FAIL CI** |
|
|
13
|
+
| **Remove response field** | **Breaking** | **FAIL CI** |
|
|
14
|
+
| **Rename response field** | **Breaking** | **FAIL CI** |
|
|
15
|
+
| **Change field type (string $\rightarrow$ integer)** | **Breaking** | **FAIL CI** |
|
|
16
|
+
| **Add required request parameter** | **Breaking** | **FAIL CI** |
|
|
17
|
+
| **Change response HTTP status code** | **Breaking** | **FAIL CI** |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 2. Breaking Change Detection in CI
|
|
22
|
+
|
|
23
|
+
Use `python3 scripts/checkBreakingChanges.py --old=spec-v1.json --new=spec-v2.json` in your pull request pipeline. Any detected breaking change requires:
|
|
24
|
+
1. Incrementing the API major version (e.g. `/v1` $\rightarrow$ `/v2`).
|
|
25
|
+
2. Setting `Deprecation` and `Sunset` headers on the previous version.
|
|
26
|
+
3. Updating migration guides.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Database Transactions & Consistency Boundaries Reference
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## 1. Transaction Scope & Boundaries
|
|
6
|
+
|
|
7
|
+
1. **Keep Transactions Short**:
|
|
8
|
+
- Never execute external HTTP calls, slow I/O, or email dispatch inside an open database transaction.
|
|
9
|
+
- Flow: Validate DTO $\rightarrow$ Open DB Transaction $\rightarrow$ Persist Rows $\rightarrow$ Commit $\rightarrow$ Dispatch Asynchronous Events.
|
|
10
|
+
2. **ACID Isolation Levels**:
|
|
11
|
+
- **Read Committed** (Default): Prevents dirty reads. Sufficient for standard CRUD operations.
|
|
12
|
+
- **Repeatable Read**: Prevents non-repeatable reads. Required for multi-row balance aggregations.
|
|
13
|
+
- **Serializable**: Full linearizability. Required for double-spend prevention where pessimistic locking is unavailable.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 2. Concurrency Control: Optimistic vs. Pessimistic
|
|
18
|
+
|
|
19
|
+
### Optimistic Locking (Recommended for High Read/Write Ratio)
|
|
20
|
+
Add a `version` column:
|
|
21
|
+
```sql
|
|
22
|
+
UPDATE accounts
|
|
23
|
+
SET balance = balance - 100, version = version + 1
|
|
24
|
+
WHERE id = :id AND version = :expected_version;
|
|
25
|
+
```
|
|
26
|
+
If affected rows = 0, throw a concurrency conflict and return `409 Conflict`.
|
|
27
|
+
|
|
28
|
+
### Pessimistic Locking (Recommended for High Contention Inventory)
|
|
29
|
+
```sql
|
|
30
|
+
SELECT * FROM inventory_items WHERE id = :id FOR UPDATE;
|
|
31
|
+
```
|
|
32
|
+
Enforce short transaction timeouts to avoid deadlocks.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 3. Distributed Transactions (Saga Pattern)
|
|
37
|
+
|
|
38
|
+
In microservice environments where 2-Phase Commit (2PC) impairs availability, use an **Orchestrated Saga**:
|
|
39
|
+
- Each local transaction commits locally.
|
|
40
|
+
- If step $N$ fails, compensating transactions are executed in reverse ($N-1 \dots 1$) to restore eventual consistency.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Distributed Systems Reliability & Fault Tolerance Reference
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## 1. Resilience Patterns
|
|
6
|
+
|
|
7
|
+
### Circuit Breakers (Martin Fowler Pattern)
|
|
8
|
+
- **Closed**: Requests flow normally. Failures are tracked.
|
|
9
|
+
- **Open**: When failure rate exceeds threshold (e.g. 50% over 10s), instantly fail fast without executing outbound calls. Return `503 Service Unavailable`.
|
|
10
|
+
- **Half-Open**: After a cooling period (e.g. 30s), allow canary requests through to probe dependency health.
|
|
11
|
+
|
|
12
|
+
### Jittered Exponential Backoff
|
|
13
|
+
When retrying transient network errors:
|
|
14
|
+
$$\text{delay} = \min(\text{cap}, \text{base} \cdot 2^{\text{attempt}}) \pm \text{random\_jitter}$$
|
|
15
|
+
*Law*: Never retry non-idempotent operations without an `Idempotency-Key`.
|
|
16
|
+
|
|
17
|
+
### Bulkheads
|
|
18
|
+
Isolate thread pools and connection pools per downstream service so a degradation in Payment Gateway does not exhaust threads for Authentication.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 2. Load Shedding & Backpressure
|
|
23
|
+
|
|
24
|
+
When CPU or connection pools reach critical thresholds ($\ge 85\%$):
|
|
25
|
+
- Immediately reject lower-priority traffic (background reports, non-essential webhooks) with `429 Too Many Requests` or `503 Service Unavailable`.
|
|
26
|
+
- Protect core checkout and authentication flows.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Multi-Tenancy Architecture & Tenant Isolation Reference
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## 1. Multi-Tenant Data Isolation Strategies
|
|
6
|
+
|
|
7
|
+
| Strategy | Architecture | Cost | Isolation | Complexity |
|
|
8
|
+
| :--- | :--- | :--- | :--- | :--- |
|
|
9
|
+
| **Shared DB, Shared Schema (Row-Level)** | `tenant_id` column on all tables. | Lowest | Logical (Code/RLS) | High discipline needed |
|
|
10
|
+
| **Shared DB, Separate Schemas** | PostgreSQL schema per tenant (`tenant_acme.invoices`). | Moderate | Schema namespace | Schema migrations overhead |
|
|
11
|
+
| **Database per Tenant** | Completely independent database instance or cluster. | Highest | Complete physical | High infrastructure cost |
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 2. Row-Level Security (PostgreSQL RLS)
|
|
16
|
+
|
|
17
|
+
To prevent BOLA leaks even if application code omits a `WHERE tenant_id = ...` filter, enforce database-level RLS:
|
|
18
|
+
```sql
|
|
19
|
+
ALTER TABLE invoices ENABLE ROW LEVEL SECURITY;
|
|
20
|
+
|
|
21
|
+
CREATE POLICY tenant_isolation_policy ON invoices
|
|
22
|
+
USING (tenant_id = current_setting('app.current_tenant_id')::uuid);
|
|
23
|
+
```
|
|
24
|
+
Set session variable upon acquiring connection:
|
|
25
|
+
```sql
|
|
26
|
+
SET LOCAL app.current_tenant_id = '01HX9...';
|
|
27
|
+
```
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# OpenAPI 3.2.1 Specifications Guide
|
|
2
|
+
|
|
3
|
+
Reference guide for OpenAPI 3.2.1 (released September 10, 2026), building upon OpenAPI 3.1 and JSON Schema 2020-12.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Key Capabilities in OpenAPI 3.2.1
|
|
8
|
+
|
|
9
|
+
### A. Root `$self` Identification
|
|
10
|
+
Allows specifications to explicitly identify their canonical URI at the root, resolving `$ref` ambiguity during local authoring and multi-file bundling:
|
|
11
|
+
```yaml
|
|
12
|
+
openapi: 3.2.1
|
|
13
|
+
$self: https://api.example.com/openapi/v1.yaml
|
|
14
|
+
info:
|
|
15
|
+
title: Enterprise Order Service
|
|
16
|
+
version: 1.0.0
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### B. First-Class Real-Time Streaming Support
|
|
20
|
+
Native support for Server-Sent Events (`text/event-stream`), JSON Lines, and JSON Sequences via `itemSchema`:
|
|
21
|
+
```yaml
|
|
22
|
+
responses:
|
|
23
|
+
'200':
|
|
24
|
+
description: Real-time order status stream
|
|
25
|
+
content:
|
|
26
|
+
text/event-stream:
|
|
27
|
+
itemSchema:
|
|
28
|
+
$ref: '#/components/schemas/OrderStatusEvent'
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### C. The HTTP `QUERY` Method
|
|
32
|
+
Native contract support for safe, idempotent read queries with complex request bodies (RFC 9110 / draft):
|
|
33
|
+
```yaml
|
|
34
|
+
paths:
|
|
35
|
+
/v1/analytics/query:
|
|
36
|
+
query:
|
|
37
|
+
summary: Complex analytical aggregation query
|
|
38
|
+
requestBody:
|
|
39
|
+
content:
|
|
40
|
+
application/json:
|
|
41
|
+
schema:
|
|
42
|
+
$ref: '#/components/schemas/AnalyticsFilterQuery'
|
|
43
|
+
responses:
|
|
44
|
+
'200':
|
|
45
|
+
description: Query results
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### D. Hierarchical Tags Taxonomies
|
|
49
|
+
Native support for grouping and categorizing operations without non-standard vendor extensions:
|
|
50
|
+
```yaml
|
|
51
|
+
tags:
|
|
52
|
+
- name: Invoicing
|
|
53
|
+
summary: Customer billing and invoices
|
|
54
|
+
kind: domain
|
|
55
|
+
- name: Payments
|
|
56
|
+
parent: Invoicing
|
|
57
|
+
summary: Payment processing and refunds
|
|
58
|
+
```
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Contextual Pagination, Idempotency & Versioning Reference
|
|
2
|
+
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## 1. Contextual Pagination Selection Matrix
|
|
6
|
+
|
|
7
|
+
| Context | Recommended Model | Request Signature | Behavior & Trade-offs |
|
|
8
|
+
| :--- | :--- | :--- | :--- |
|
|
9
|
+
| **Small Admin Tables** ($< 1,000$ rows) | **Offset** | `?page=2&limit=20` | Simple for users to jump to page N. Degrades on large tables (`OFFSET 100000`). |
|
|
10
|
+
| **Large Datasets** ($> 10,000$ rows) | **Cursor** | `?cursor=eyJpZCI6...&limit=50` | Constant $O(1)$ database execution using indexed comparison (`WHERE id > :cursor_id`). |
|
|
11
|
+
| **Frequently Mutated Data** | **Cursor** | `?after=token&limit=25` | Prevents duplicate or skipped records when rows are inserted/deleted mid-browse. |
|
|
12
|
+
| **Data Exports / Analytics** | **Keyset** | `?since_id=105400&limit=500` | High throughput sequential scanning without pagination state overhead. |
|
|
13
|
+
|
|
14
|
+
### Universal Constraint
|
|
15
|
+
Every strategy must enforce a hard limit: `limit = Math.min(requestedLimit || 20, 100)`.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 2. Safe Retries via IETF Internet-Draft `Idempotency-Key`
|
|
20
|
+
|
|
21
|
+
Status: **IETF Internet-Draft (`draft-ietf-httpapi-idempotency-key-header-08`)**
|
|
22
|
+
|
|
23
|
+
### Protocol State Machine
|
|
24
|
+
```
|
|
25
|
+
Client Request
|
|
26
|
+
|
|
|
27
|
+
v
|
|
28
|
+
Has Idempotency-Key Header?
|
|
29
|
+
|
|
|
30
|
+
+---> NO --> Execute normal request flow.
|
|
31
|
+
|
|
|
32
|
+
+---> YES --> Query Cache/DB for key
|
|
33
|
+
|
|
|
34
|
+
+---> Found in Cache?
|
|
35
|
+
|
|
|
36
|
+
+-- Status: IN_FLIGHT --> Return 409 Conflict
|
|
37
|
+
|
|
|
38
|
+
+-- Payload Fingerprint Mismatch? --> Return 422 Unprocessable Content
|
|
39
|
+
|
|
|
40
|
+
+-- Status: COMPLETED --> Replay Cached Status Code & Body
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Fingerprint Generation (SHA-256)
|
|
44
|
+
Compute hash over: `HTTP_METHOD + PATH + REQUEST_BODY`. Store alongside the idempotency token for 24 hours.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 3. Deprecation Header Standards
|
|
49
|
+
|
|
50
|
+
When retiring an endpoint, emit exact headers:
|
|
51
|
+
```http
|
|
52
|
+
Deprecation: @1794787200
|
|
53
|
+
Sunset: Tue, 17 Nov 2026 00:00:00 GMT
|
|
54
|
+
Link: <https://api.example.com/docs/v2-migration>; rel="deprecation"
|
|
55
|
+
```
|
|
56
|
+
- `Deprecation`: RFC 9651 Structured Field Date prefixed with `@`.
|
|
57
|
+
- `Sunset`: RFC 8594 HTTP-date timestamp.
|