experience-documentation.html

Descriptions, summaries, examples, and references that make the API self-explanatory.

172 rules experience: documentation 136 inlined · 36 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-documentation.spotlight.yaml

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

Ruleset definition

Loading…

Rules in this ruleset (172)

Skill Body Present Agent Skill

Skill Has Examples Section Agent Skill

Skill Has Usage Section Agent Skill

API Contact Include Email APIs.json

API Contact Include Full Name APIs.json

API Include About Page APIs.json

API Include Contact APIs.json

API Property Require Road Map APIs.json

API Property Require Sandbox APIs.json

API Property Require Security Page APIs.json

API Property Require Support Email APIs.json

API Property Require Support Issues URL APIs.json

API Property Require Support Page APIs.json

API Property Require Team APIs.json

API Property Require Terms Of Service APIs.json

API Property Require Use Cases APIs.json

API Property Require Versioning APIs.json

API Property Require Video APIs.json

Document Include Business Impact Canvas APIs.json

Document Include Business Model Canvas APIs.json

Document Include Capacity Canvas APIs.json

Document Include Customer Journey Canvas APIs.json

Document Include Domain Canvas APIs.json

Document Include Event Canvas APIs.json

Document Include Locations Canvas APIs.json

Document Include Rest Canvas APIs.json

Document Include Value Proposition Canvas APIs.json

Schema Include API Plan APIs.json

Schema Include Authentication Page APIs.json

Schema Include Blog APIs.json

Schema Include Blog Feed APIs.json

Schema Include Change Log APIs.json

Schema Include Documentation APIs.json

Schema Include Examples APIs.json

Schema Include Feedback Email APIs.json

Schema Include Feedback Issues URL APIs.json

Schema Include Getting Started APIs.json

Schema Include Github Organization APIs.json

Schema Include Github Repository APIs.json

Schema Include Insomnia Collection APIs.json

Schema Include Interface License APIs.json

Schema Include Mock Server APIs.json

Schema Include Openapi Definition APIs.json

Schema Include Performance Testing APIs.json

Schema Include Postman Collection APIs.json

Schema Include Pricing APIs.json

Schema Include Privacy Policy APIs.json

Schema Include Questions Issues URL APIs.json

Schema Include Rate Limit Reference APIs.json

Schema Include Version Comparison APIs.json

Arazzo Info Description Arazzo engine

Arazzo Info Summary Arazzo engine

Arazzo Step Description Arazzo engine

Arazzo Workflow Description Arazzo engine

Arazzo Workflow Summary Arazzo engine

Info Arazzo Require Title Arazzo

Source Arazzo Description Require Name Arazzo

Asyncapi 3 Operation Description AsyncAPI engine

Asyncapi 3 Tag Description AsyncAPI engine

Asyncapi 3 Tags AsyncAPI engine

Asyncapi Info Contact AsyncAPI engine

Asyncapi Info Contact Properties AsyncAPI engine

Asyncapi Info Description AsyncAPI engine

Asyncapi Info License AsyncAPI engine

Asyncapi Info License URL AsyncAPI engine

Asyncapi Message Examples AsyncAPI engine

Asyncapi Operation Description AsyncAPI engine

Asyncapi Parameter Description AsyncAPI engine

Asyncapi Payload Examples AsyncAPI engine

Asyncapi Schema Examples AsyncAPI engine

Asyncapi Servers AsyncAPI engine

Asyncapi Tag Description AsyncAPI engine

Asyncapi Tags AsyncAPI engine

Channel Asyncapi Require Description AsyncAPI

Component Asyncapi Message Require Name AsyncAPI

Component Asyncapi Message Require Title AsyncAPI

Info Asyncapi Require Title AsyncAPI

Operation Asyncapi Require Summary AsyncAPI

Operation Asyncapi Require Tag AsyncAPI

Schema Asyncapi Property Require Description AsyncAPI

Server Asyncapi Require Description AsyncAPI

Document FinOps Require Description FinOps

Document Require Description JSON Schema

Document Require Title JSON Schema

Schema Property Require Description JSON Schema

Schema JSON Structure Property Require Description JSON Structure

Document MCP Description Meaningful MCP

Document Require Description MCP

Document Require Instructions MCP

Channel Parameter Require Examples OpenAPI

Component Message Require Examples OpenAPI

Contact Properties OpenAPI engine

Document Cache Control Parameter OpenAPI

Document Cache Response Header OpenAPI

Document Require External Docs OpenAPI

Document Require Realistic Examples OpenAPI

Header Require Examples OpenAPI

Info Contact OpenAPI engine

Info Contact Require Email OpenAPI

Info Contact Require Name OpenAPI

Info Contact Require URL OpenAPI

Info Description OpenAPI engine

Info Description Length Limit OpenAPI

Info Description No Eval Tag OpenAPI

Info Description No Script Tag OpenAPI

Info License OpenAPI engine

Info License Require Name OpenAPI

Info License Require URL OpenAPI

Info Require Contact 2 OpenAPI

Info Require Description OpenAPI

Info Require License OpenAPI

Info Require Summary OpenAPI

Info Require Terms Of Service OpenAPI

Info Require Title OpenAPI

Info Title Max Length OpenAPI

License URL OpenAPI engine

Message Examples Form Complete Mocks OpenAPI

Message Require Examples OpenAPI

OAS3 API Servers OpenAPI engine

OAS3 Examples Value Or ExternalValue OpenAPI engine

OAS3 Parameter Description OpenAPI engine

OAS3 Valid Media Example OpenAPI engine

OAS3 Valid Schema Example OpenAPI engine

Openapi Tags OpenAPI engine

Operation Deprecated Require Description OpenAPI

Operation Description OpenAPI engine

Operation Description Max Length OpenAPI

Operation Examples Form Complete Mocks OpenAPI

Operation Require Description OpenAPI

Operation Require Response OpenAPI

Operation Require Summary OpenAPI

Operation Require Tag OpenAPI

Operation Success Response OpenAPI engine

Operation Summary Description Differ OpenAPI

Operation Summary Max Length OpenAPI

Operation Summary No Period OpenAPI

Operation Tags OpenAPI engine

Parameter Deprecated Require Description OpenAPI

Parameter Description Max Length OpenAPI

Parameter Optional Include Examples OpenAPI

Parameter Require Description OpenAPI

Parameter Require Examples OpenAPI

Parameter Require In OpenAPI

Parameter Require Name OpenAPI

Parameter Require Required Flag OpenAPI

Parameter Require Schema OpenAPI

Parameter Required Require Examples OpenAPI

Path Params Declared In Block OpenAPI

Path Success Response Require Description OpenAPI

Request Content Require Examples OpenAPI

Response 400 Require Body OpenAPI

Response Content Require Examples OpenAPI

Response Define 401 OpenAPI

Response Define 404 OpenAPI

Response Error Require Description OpenAPI

Response Include Ratelimit Header OpenAPI

Schema Deprecated Property Require Description OpenAPI

Schema Description Max Length OpenAPI

Schema Property Description Max Length OpenAPI

Schema Property Require Description OpenAPI

Schema Property Require Examples OpenAPI

Schema Require Description OpenAPI

Schema Require Info Object OpenAPI

Security JWT Scheme Require Description OpenAPI

Security OAuth Scheme Require Description OpenAPI

Server Require Description OpenAPI

Tag Description OpenAPI engine

Document Require Description Plans

Plan Features Non Empty Plans

Plan Require Description Plans

Plan Require Features Plans

Document Require Description Rate Limits

← All experience rulesets