Settings

Every OpenAPI Guard setting for VS Code, with defaults.

Documentation pages

All settings can be set for the user, the workspace, or a single workspace folder.

Setting Default What it does
stackblender.openApiGuard.enabled true Turns analysis, diagnostics, CodeLens, and navigation on or off.
stackblender.openApiGuard.specs [] Workspace-relative contract paths to analyze; empty analyzes every contract found. See Specifications.
stackblender.openApiGuard.spec "" Deprecated single path, still honored alongside specs.
stackblender.openApiGuard.severity "warning" Severity of every rule: error, warning, information, or hint.
stackblender.openApiGuard.ruleSeverity {} Per-rule severity, or off, overriding severity.
stackblender.openApiGuard.include ["**/*.java", "**/*.kt", "**/*.ts"] Source files to analyze.
stackblender.openApiGuard.exclude build output and node_modules Source files to skip. Generated sources are still read unless excluded explicitly.
stackblender.openApiGuard.implementationPathPrefix "" A prefix added to every implementation path before comparing, such as a NestJS global prefix.
stackblender.openApiGuard.codeLens true Shows the navigation CodeLens.

Per-rule severity, for example:

"stackblender.openApiGuard.ruleSeverity": {
  "undocumented-implementation": "information",
  "http-method-mismatch": "error",
  "missing-implementation": "off",
  "analysis-limitation": "hint"
}