Document Require Type
document-require-type
info
experience: data-modelingexperience: discoverability
spec: document
@type should be present
The @type property should be present.
Rule definition
The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.
document-require-type:
title: Document Require Type
reference: https://spotlight-rules.com/spec/rules/json-ld/document-require-type/
description: The `@type` property should be present.
message: "@type should be present"
severity: info
given: $
then:
field: "@type"
function: truthy
tags:
- format:json-ld
- spec:document
- experience:data-modeling
- experience:discoverability
prompt: "You are editing a JSON-LD document to satisfy the Spotlight API
governance rule 'document-require-type' (Document Require Type).
Requirement: The `@type` property should be present. To fix: Ensure `@type`
is present and non-empty at each matching location. Make the smallest change
that satisfies the rule, leave all unrelated content, key order, comments,
and formatting unchanged, and keep the document valid JSON-LD. Return only
the complete corrected document, with no commentary."
AI fix prompt — send this to Claude, Gemini, or ChatGPT with your artifact to auto-fix this rule
You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: The `@type` property should be present. To fix: Ensure `@type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary.| Artifact | JSON-LD |
|---|---|
| Applies at (given) | $ |
| Severity | info — educational by default; raise to warn/error to enforce |
| Reference | https://spotlight-rules.com/spec/rules/json-ld/document-require-type/ |