Interface: UndocumentedValue

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

A value outside the set the schema lists for a field.

The counterpart of an undocumented key, and every bit as much a gap in the specification rather than breakage: the field is described, its list of values is not complete. Kept apart from the other kind because the repair differs — a missing key has to be added to a schema, a missing value to an enum.

Extends

• DriftLocation

Properties

documented

documented: string[];

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

The values the schema lists.

---

endpoint

endpoint: string;

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

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

Inherited from

DriftLocation.endpoint

---

kind

kind: "value";

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

---

path

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

DriftLocation.path

---

value

value: string;

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

The value the API sent.