index
Interfaces
| Interface | Description |
|---|---|
| components | - |
Type Aliases
| Type Alias | Description |
|---|---|
| Address | - |
| AssertNoRootResponseBodiesOptions | - |
| ExtractRequestBody | Convenience type to lookup the request body by operationId. |
| ExtractRequestPathParams | Convenience type to lookup the path params by operationId. |
| ExtractRequestQueryParams | Convenience type to lookup the query params by operationId. |
| ExtractResponseBody | Convenience type to lookup the response body by operationId. |
| OpenApiDocument | Bundled OpenAPI document accepted by express-openapi-validator (3.0.x or 3.1.x). |
| OpenApiEnforcedTag | - |
| OpenApiEnforcedTagMeta | - |
| OpenApiTagViolation | - |
| RootResponseAllowKey | operationId:statusCode, e.g. getMatter:200. |
| RootResponseBodyViolation | - |
Variables
| Variable | Description |
|---|---|
| OPENAPI_ENFORCED_TAG_CATALOG | - |
| OPENAPI_ENFORCED_TAG_SET | - |
| OPENAPI_ENFORCED_TAGS | - |
| OPENAPI_TAG_BACKGROUND | Marks an operation as invocable by the job queue. |
| OPENAPI_TAG_CSRF_EXEMPT | - |
| OPENAPI_TAG_EMAIL_VERIFIED | - |
| OPENAPI_TAG_MFA_REQUIRED | - |
| OPENAPI_TAG_NO_AUTH | - |
| OPENAPI_TAG_SITE_ADMIN_ONLY | - |
Functions
| Function | Description |
|---|---|
| asOpenApiDocument | Cast an inline OpenAPI object (e.g. in tests) to OpenApiDocument. |
| assertNoRootResponseBodies | Throw if any success JSON response puts a resource at the document root. Pass current offenders in allow and remove entries as routes are migrated. |
| assertOpenApiOperationTags | Throw if any operation uses a tag outside OPENAPI_ENFORCED_TAGS. Call at startup when loading a product OpenAPI document (and from package tests). |
| assertOpenApiRouteFileTags | - |
| castJson | OpenAPI JSON from import * as json from "./openapi.json" with { type: "json" }. |
| findRootResponseBodyViolations | Find 2xx application/json response schemas that put a business object, array, or bare $ref at the document root instead of a flat keyed envelope ({ recipe: Recipe }, { recipes: Recipe[] }). |
| findUnknownOpenApiOperationTags | Collect unknown operation tags from a bundled (or single-operation) OpenAPI document. |
| findUnknownOpenApiRouteFileTags | Scan routes YAML under a spec package for unknown operation tags. Prefer this in package tests; use assertOpenApiOperationTags on the bundled document at process startup. |