experience-reliability.html

Defensive contracts — status codes, error shapes, and required fields that hold up in production.

155 rules experience: reliability 93 inlined · 62 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-reliability.spotlight.yaml

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

Ruleset definition

Loading…

Rules in this ruleset (155)

Skill Body Length Agent Skill

Skill Body Present Agent Skill

API Property Require Status Page APIs.json

Schema Include Github Action APIs.json

Schema Include Performance Testing APIs.json

Schema Include Production Environment APIs.json

Schema Include Rate Limit Reference APIs.json

Schema Include Staging Environment APIs.json

Arazzo Document Schema Arazzo engine

Arazzo Source Descriptions Type Arazzo engine

Arazzo Step Failure Actions Validation Arazzo engine

Arazzo Step Output Validation Arazzo engine

Arazzo Step Parameters Validation Arazzo engine

Arazzo Step Request Body Validation Arazzo engine

Arazzo Step Success Actions Validation Arazzo engine

Arazzo Step Success Criteria Validation Arazzo engine

Arazzo Step Validation Arazzo engine

Arazzo Workflow Depends On Validation Arazzo engine

Arazzo Workflow Output Validation Arazzo engine

Arazzo Workflow StepId Unique Arazzo engine

Arazzo WorkflowId Unique Arazzo engine

Workflow Arazzo Require Step Arazzo

Workflow Arazzo Step Require Operation Arazzo

Workflow Arazzo Step Require Success Criteria Arazzo

Asyncapi 3 Channel No Empty Parameter AsyncAPI engine

Asyncapi 3 Channel Servers AsyncAPI engine

Asyncapi 3 Document Unresolved AsyncAPI engine

Asyncapi 3 Headers Schema Type Object AsyncAPI engine

Asyncapi 3 Operation Security AsyncAPI engine

Asyncapi 3 Payload Unsupported SchemaFormat AsyncAPI engine

Asyncapi 3 Server No Empty Variable AsyncAPI engine

Asyncapi 3 Server No Trailing Slash AsyncAPI engine

Asyncapi 3 Server Not Example Com AsyncAPI engine

Asyncapi Channel No Empty Parameter AsyncAPI engine

Asyncapi Channel Parameters AsyncAPI engine

Asyncapi Channel Servers AsyncAPI engine

Asyncapi Headers Schema Type Object AsyncAPI engine

Asyncapi Message Examples AsyncAPI engine

Asyncapi Message MessageId Uniqueness AsyncAPI engine

Asyncapi Operation OperationId Uniqueness AsyncAPI engine

Asyncapi Operation Security 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 Server No Empty Variable AsyncAPI engine

Asyncapi Server No Trailing Slash AsyncAPI engine

Asyncapi Server Not Example Com AsyncAPI engine

Asyncapi Server Security AsyncAPI engine

Asyncapi Server Variables AsyncAPI engine

Asyncapi Servers AsyncAPI engine

Asyncapi Unused Components Server AsyncAPI engine

Component Asyncapi Message Require Correlation ID AsyncAPI

Agentic Access Core Fields OpenAPI

Array Items OpenAPI engine

Document Cache Control Parameter OpenAPI

Document Cache Response Header OpenAPI

No $ref Siblings OpenAPI engine

OAS3 API Servers OpenAPI engine

OAS3 Callbacks In Callbacks OpenAPI engine

OAS3 Operation Security Defined OpenAPI engine

OAS3 Schema OpenAPI engine

OAS3 Server Not Example.com OpenAPI engine

OAS3 Server Trailing Slash OpenAPI engine

OAS3 Server Variables OpenAPI engine

OAS3 Valid Media Example OpenAPI engine

OAS3 Valid Schema Example OpenAPI engine

OAS3.1 Callbacks In Webhook OpenAPI engine

OAS3.1 Servers In Webhook OpenAPI engine

Operation Collection Support Sparse Fieldsets OpenAPI

Operation Define 429 Response OpenAPI

Operation Define 500 Response OpenAPI

Operation Get Support If Modified Since OpenAPI

Operation Get Support If None Match OpenAPI

Operation Mutation Support Idempotency Key OpenAPI

Operation OperationId Unique OpenAPI engine

Operation Parameters OpenAPI engine

Operation Patch Must Have Request Body OpenAPI

Operation Success Response OpenAPI engine

Operation Write Support If Match OpenAPI

Operation Write Support If Unmodified Since OpenAPI

Parameter Collection Limit Param Maximum OpenAPI

Parameter Integer Require Maximum OpenAPI

Parameter Integer Require Minimum OpenAPI

Parameter String Require Max Length OpenAPI

Parameter String Require Min Length OpenAPI

Parameter String Require Pattern OpenAPI

Path Declarations Must Exist OpenAPI engine

Path Params OpenAPI engine

Path Require Tracing Header OpenAPI

Request Delete Must Not Have Body OpenAPI

Request Get Must Not Have Body OpenAPI

Request Head Must Not Have Body OpenAPI

Request Options Must Not Have Body OpenAPI

Request Support Accept Encoding OpenAPI

Request Support Baggage OpenAPI

Request Support Correlation ID OpenAPI

Request Support Tracestate OpenAPI

Response 202 Location Header OpenAPI

Response 202 Retry After OpenAPI

Response Cache Header No Conflict OpenAPI

Response Define 429 OpenAPI

Response Define 500 OpenAPI

Response Delete Define 204 OpenAPI

Response Delete Define 500 OpenAPI

Response Delete Must Not Return Body OpenAPI

Response Get Cache Control OpenAPI

Response Get Define 200 OpenAPI

Response Get Define 500 OpenAPI

Response Get Document 304 Not Modified OpenAPI

Response Get ETag OpenAPI

Response Get Last Modified OpenAPI

Response Get Must Return Body OpenAPI

Response Get Vary OpenAPI

Response Head Must Not Return Body OpenAPI

Response Include Ratelimit Header OpenAPI

Response Options Must Not Return Body OpenAPI

Response Patch Define 200 OpenAPI

Response Patch Define 400 OpenAPI

Response Patch Define 404 OpenAPI

Response Post Define 201 OpenAPI

Response Post Define 400 OpenAPI

Response Post Define 500 OpenAPI

Response Put Define 400 OpenAPI

Response Put Define 500 OpenAPI

Response Ratelimit Header OpenAPI

Response Ratelimit Policy OpenAPI

Response Require Status Health Check Path OpenAPI

Response Return Correlation ID OpenAPI

Response Status Path Problem Schema Fields OpenAPI

Response Status Path Return Problem Type OpenAPI

Response Success Require Ratelimit Header OpenAPI

Response Throttled Require Retry After OpenAPI

Response Write Document 412 Precondition Failed OpenAPI

Response Write ETag OpenAPI

Schema Array Property Require Max Items OpenAPI

Schema Array Property Require Min Items OpenAPI

Schema Get Define 404 Response OpenAPI

Schema Monetary Property Avoid Float OpenAPI

Schema Number Property Require Maximum OpenAPI

Schema Number Property Require Minimum OpenAPI

Schema String Property Require Max Length OpenAPI

Schema String Property Require Min Length OpenAPI

Server Must Use HTTPS OpenAPI

Plan Require Limit Plans

Document Require Limit Rate Limits

Limit Max Positive Rate Limits

Limit Require Max Rate Limits

Limit Require Name Rate Limits

Limit Require Scope Rate Limits

Limit Require Window Rate Limits

Limit Window Format Rate Limits

← All experience rulesets