Interface DataFormatSchema

Declarative spec describing what is well-formed in a given data format — the rule book inspectDataModel validates a DataModel against. Plug-in inspections that want richer constraints can read additional fields off the schema via TS declaration merging.

interface DataFormatSchema {
    description?: string;
    id: string;
    objectTypes?: { [typeId: string]: ObjectTypeSpec };
    relationshipTypes?: { [typeId: string]: RelationshipTypeSpec };
}

Properties

description? id objectTypes? relationshipTypes?

Properties

Optionaldescription

description?: string

id

id: string

Compared against DataObject.schema and Relationship.schema by schemaTagging.

OptionalobjectTypes

objectTypes?: { [typeId: string]: ObjectTypeSpec }

Allowed DataObject types. Empty / missing disables type registration checks.

OptionalrelationshipTypes

relationshipTypes?: { [typeId: string]: RelationshipTypeSpec }

Allowed Relationship types. Empty / missing disables type registration checks.

Settings

Member Visibility

On This Page

Properties