dependabit / monitor/src / OpenAPIChecker

Class: OpenAPIChecker

Defined in: packages/monitor/src/checkers/openapi.ts:65

Contract for all dependency checker implementations.

Remarks

The Monitor selects a checker based on AccessConfig.accessMethod and calls fetch followed by compare. Plugins implement this interface to extend the set of supported access methods.

Use When

Implementing a custom checker for a new access method (e.g., a proprietary API or registry). Register it with Monitor.registerChecker.

Pitfalls

• fetch should throw only for unrecoverable errors (network failure, auth error). Temporary 5xx responses should be retried inside the implementation to avoid marking the dependency as errored.
• compare receives the stored previous snapshot and the live current snapshot. Do not assume both snapshots were produced by the same checker version.

Implements

• Checker

Constructors

Constructor

new OpenAPIChecker(): OpenAPIChecker;

Returns

OpenAPIChecker

Methods

compare()

compare(prev, curr): Promise<ChangeDetection>;

Defined in: packages/monitor/src/checkers/openapi.ts:185

Compares two OpenAPI snapshots with semantic diffing

Parameters

Parameter	Type
prev	DependencySnapshot
curr	DependencySnapshot

Returns

Promise<ChangeDetection>

Implementation of

Checker.compare

---

fetch()

fetch(config): Promise<DependencySnapshot>;

Defined in: packages/monitor/src/checkers/openapi.ts:69

Fetches and parses OpenAPI specification

Parameters

Parameter	Type
config	AccessConfig

Returns

Promise<DependencySnapshot>

Implementation of

Checker.fetch