Document Require Property
document-require-property
info
experience: data-modelingexperience: consistency
spec: schemas
properties should be present
The properties 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-property:
title: Document Require Property
reference: https://spotlight-rules.com/spec/rules/json-structure/document-require-property/
description: The `properties` property should be present.
message: properties should be present
severity: info
given: $
then:
field: properties
function: truthy
tags:
- format:json-structure
- spec:schemas
- experience:data-modeling
- experience:consistency
prompt: "You are editing a JSON Structure document to satisfy the Spotlight API
governance rule 'document-require-property' (Document Require Property).
Requirement: The `properties` property should be present. To fix: Ensure
`properties` 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
Structure. 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 Structure document to satisfy the Spotlight API governance rule 'document-require-property' (Document Require Property). Requirement: The `properties` property should be present. To fix: Ensure `properties` 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 Structure. Return only the complete corrected document, with no commentary.
| Artifact | JSON Structure |
|---|---|
| Applies at (given) | $ |
| Severity | info — educational by default; raise to warn/error to enforce |
| Reference | https://spotlight-rules.com/spec/rules/json-structure/document-require-property/ |