experience-data-modeling.html

Well-formed schemas, types, and constraints for clean, validatable data.

143 rules experience: data-modeling 118 inlined · 25 from the engine

Run this ruleset

Lint any matching artifact against this ruleset with the Spotlight CLI:

npm i -g @spotlight-rules/spotlight-cli
spotlight lint api.yaml \
  --ruleset https://apicommons.org/assets/rulesets/experience-data-modeling.spotlight.yaml

Or load it into the browser validator, post it to the HTTP API, or wire it into a CI gate. 25 of these rules are the engine's built-ins (they come with spotlight:*); the other 118 are inlined in the file below.

Ruleset definition

Loading…

Rules in this ruleset (143)

Skill Metadata Object Agent Skill

API Entry Require Tag APIs.json

Arazzo Document Schema Arazzo engine

Arazzo Step Output Validation Arazzo engine

Arazzo Step Parameters Validation Arazzo engine

Arazzo Step Request Body Validation Arazzo engine

Arazzo Workflow Output Validation Arazzo engine

Asyncapi 3 Document Unresolved AsyncAPI engine

Asyncapi 3 Headers Schema Type Object AsyncAPI engine

Asyncapi 3 Payload Unsupported SchemaFormat AsyncAPI engine

Asyncapi Headers Schema Type Object AsyncAPI engine

Asyncapi Message Examples AsyncAPI engine

Asyncapi Payload AsyncAPI engine

Asyncapi Payload Default AsyncAPI engine

Asyncapi Payload Examples AsyncAPI engine

Asyncapi Payload Unsupported SchemaFormat AsyncAPI engine

Asyncapi Schema AsyncAPI engine

Asyncapi Schema Default AsyncAPI engine

Asyncapi Schema Examples AsyncAPI engine

Asyncapi Unused Components Schema AsyncAPI engine

Component Asyncapi Message Require Contenttype AsyncAPI

Component Asyncapi Message Require Payload AsyncAPI

Cost FinOps Monthly Non Negative FinOps

Cost FinOps Require Monthly FinOps

Cost FinOps Require Service FinOps

Document FinOps Budget Non Negative FinOps

Document FinOps Currency Iso4217 FinOps

Document FinOps Require Budget FinOps

Document FinOps Require Cost FinOps

Document FinOps Require Currency FinOps

Document FinOps Require Name FinOps

Document Require Context JSON-LD

Document Require ID JSON-LD

Document Require Type JSON-LD

Schema JSON LD Context URI Or Object JSON-LD

Schema JSON LD Type String Or Array JSON-LD

Document Require Description JSON Schema

Document Require ID JSON Schema

Document Require Property JSON Schema

Document Require Required List JSON Schema

Document Require Title JSON Schema

Document Require Type JSON Schema

Schema Property Require Description JSON Schema

Schema Property Require Type JSON Schema

Schema Require JSON Schema

Document Require ID JSON Structure

Document Require Name JSON Structure

Document Require Property JSON Structure

Document Require Type JSON Structure

Schema JSON Structure Property Require Type JSON Structure

Schema JSON Structure Root Type Object JSON Structure

Schema Property Require Type JSON Structure

Schema Require JSON Structure

Capability Require Prompts MCP

Capability Require Resources MCP

Capability Require Tools MCP

Document Require Capabilities MCP

Document Require Description MCP

Document Require Name MCP

Info Require Version MCP

Array Items OpenAPI engine

Duplicated Entry In Enum OpenAPI engine

OAS3 Schema OpenAPI engine

OAS3 Unused Component OpenAPI engine

OAS3 Valid Media Example OpenAPI engine

OAS3 Valid Schema Example OpenAPI engine

Operation Post Require Request Body OpenAPI

Parameter Array Require Items OpenAPI

Parameter Array Typed Items OpenAPI

Parameter Avoid Integer ID OpenAPI

Parameter Integer Require Maximum OpenAPI

Parameter Integer Require Minimum OpenAPI

Parameter Require In OpenAPI

Parameter Require Required Flag OpenAPI

Parameter Require Schema OpenAPI

Parameter Schema Require Type OpenAPI

Parameter Schema Use Ref OpenAPI

Parameter String Require Max Length OpenAPI

Parameter String Require Min Length OpenAPI

Parameter String Require Pattern OpenAPI

Path Delete No Response Body OpenAPI

Path Get Response Support JSON OpenAPI

Path Write Response Support JSON OpenAPI

Request Patch Media Type Not Plain JSON OpenAPI

Request Post Collection Require Paging Object OpenAPI

Response 206 Require Content Range OpenAPI

Response Body Must Be Object OpenAPI

Response Collection Require Results Array OpenAPI

Response Success Use HAL JSON OpenAPI

Response Use JSON API OpenAPI

Response Use Standard Mime Types OpenAPI

Response Write Require Content Type OpenAPI

Schema Array Property Require Items OpenAPI

Schema Array Property Require Max Items OpenAPI

Schema Array Property Require Min Items OpenAPI

Schema Array Property Typed Items OpenAPI

Schema Array Require Min Max Items OpenAPI

Schema Created Datetime Must Be Date Time OpenAPI

Schema Createdby Property Must Be String OpenAPI

Schema Date Time Property Require Format OpenAPI

Schema Deletedby Property Must Be String OpenAPI

Schema Description Property Must Be String OpenAPI

Schema Enum Not Empty OpenAPI

Schema Fingerprint Property Must Be String OpenAPI

Schema ID Property Must Be String OpenAPI

Schema Integer Format Allowed Values OpenAPI

Schema Integer Require Format OpenAPI

Schema Modified Datetime Must Be Date Time OpenAPI

Schema Modifiedby Property Must Be String OpenAPI

Schema Monetary Property Avoid Float OpenAPI

Schema Name Property Must Be String OpenAPI

Schema Number Format Allowed Values OpenAPI

Schema Number Property Require Maximum OpenAPI

Schema Number Property Require Minimum OpenAPI

Schema Number Require Format OpenAPI

Schema Number Require Min Max OpenAPI

Schema Object Constrain Additional Property OpenAPI

Schema Object Disallow Additional Property OpenAPI

Schema Object Set Additional Property OpenAPI

Schema Orgid Property Must Be String OpenAPI

Schema Property Require Description OpenAPI

Schema Property Require Type OpenAPI

Schema Ref Property Must Be String OpenAPI

Schema Ref Property Require Format OpenAPI

Schema Ref Property Standard OpenAPI

Schema Requestid Property Must Be String OpenAPI

Schema Require Description OpenAPI

Schema Require Name OpenAPI

Schema Require Type OpenAPI

Schema String Property Require Max Length OpenAPI

Schema String Property Require Min Length OpenAPI

Schema String Require Max Length OpenAPI

Schema String Require Pattern Or Format OpenAPI

Typed Enum OpenAPI engine

Document Require Name Plans

Document Require Plan Plans

Plan Currency Iso4217 Plans

Plan Price Non Negative Plans

Plan Require Name Plans

Document Require Limit Rate Limits

Document Require Name Rate Limits

Limit Max Positive Rate Limits

Limit Require Name Rate Limits

← All experience rulesets