Skip to content

Interface: UndocumentedKeys

Defined in: src/core/schemaAudit.ts:22

Keys the API sends that the schema does not describe.

Extends

  • DriftLocation

Properties

endpoint

ts
endpoint: string;

Defined in: src/core/schemaAudit.ts:16

The request that produced the response, e.g. GET /wiki/api/v2/spaces.

Inherited from

ts
DriftLocation.endpoint

keys

ts
keys: string[];

Defined in: src/core/schemaAudit.ts:24


kind

ts
kind: "keys";

Defined in: src/core/schemaAudit.ts:23


path

ts
path: string;

Defined in: src/core/schemaAudit.ts:18

Where in the response body it turned up. Empty string for the top level.

Inherited from

ts
DriftLocation.path

types

ts
types: Record<string, string>;

Defined in: src/core/schemaAudit.ts:26

What each of those keys actually held, so the missing field can be written into the schema.