experience-naming.html

Casing, vocabulary, and naming conventions applied consistently across the surface.

100 rules experience: naming 86 inlined · 14 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-naming.spotlight.yaml

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

Ruleset definition

Download YAML 

Loading…

Rules in this ruleset (100)

Skill Name Kebab Case Agent Skill
Skill Name Max Length Agent Skill
API Property Require Vocabulary APIs.json
API Tag Require Upper Case APIs.json
Tag Require Upper Case APIs.json
Arazzo Step StepId Arazzo engine
Arazzo Workflow StepId Unique Arazzo engine
Arazzo Workflow WorkflowId Arazzo engine
Arazzo WorkflowId Unique Arazzo engine
Asyncapi 3 Channel No Query Nor Fragment AsyncAPI engine
Asyncapi 3 Channel No Trailing Slash AsyncAPI engine
Asyncapi Channel No Query Nor Fragment AsyncAPI engine
Asyncapi Channel No Trailing Slash AsyncAPI engine
Asyncapi Message MessageId Uniqueness AsyncAPI engine
Asyncapi Operation OperationId Uniqueness AsyncAPI engine
Schema Asyncapi Property Camel Case AsyncAPI
Schema JSON Structure Property Camel Case JSON Structure
Document MCP Name Kebab Case MCP
Component Example Keys Snake Case OpenAPI
Header Names Hyphenated Pascal Case OpenAPI
Header No X Prefix OpenAPI
Info Title Capitalized OpenAPI
Operation ID Camel Case OpenAPI
Operation ID URL Safe OpenAPI
Operation OperationId Unique OpenAPI engine
Operation OperationId Valid In URL OpenAPI engine
Operation Tag Title Case OpenAPI
Parameter Enum Upper Snake Case OpenAPI
Parameter Keys Snake Case OpenAPI
Parameter Name Max Length OpenAPI
Parameter Names Camel Case OpenAPI
Parameter No X Prefixed Request Header OpenAPI
Parameter Query Allowed Characters OpenAPI
Parameter Query Camel Case OpenAPI
Parameter Require Name OpenAPI
Path Keys No Trailing Slash OpenAPI engine
Path No API Prefix In OpenAPI
Path No Empty Segment OpenAPI
Path No Environment Names In OpenAPI
Path No File Extension In OpenAPI
Path No File Extensions OpenAPI
Path No Format Extensions In OpenAPI
Path No HTTP Method Names OpenAPI
Path No HTTP Methods In OpenAPI
Path No HTTP Verbs OpenAPI
Path No Invalid Symbols OpenAPI
Path No Query String OpenAPI
Path No Query Strings In OpenAPI
Path No Technology Leak In OpenAPI
Path No Trailing Slash OpenAPI
Path No Trailing Slash In OpenAPI
Path No Verbs OpenAPI
Path No X Prefixed Response Header OpenAPI
Path Not Include Query OpenAPI engine
Path Parameter Camel Case OpenAPI
Path Parameter Constant Case OpenAPI
Path Parameter Kebab Case OpenAPI
Path Parameter Pascal Case OpenAPI
Path Parameter Snake Case OpenAPI
Path Resources Plural OpenAPI
Path Segment Kebab Case OpenAPI
Path Use Standard HTTP Methods OpenAPI
Request Header Names Pascal Case OpenAPI
Request Property Names Camel Case OpenAPI
Response Custom Header Naming Format OpenAPI
Response Header Names Pascal Case OpenAPI
Response Header No X Prefix OpenAPI
Response Keys Snake Case OpenAPI
Response Names Pascal Case OpenAPI
Schema Boolean No Prefix OpenAPI
Schema Definition Camel Case OpenAPI
Schema Definition Constant Case OpenAPI
Schema Definition Kebab Case OpenAPI
Schema Definition Pascal Case OpenAPI
Schema Definition Snake Case OpenAPI
Schema Keys Snake Case OpenAPI
Schema Name Max Length OpenAPI
Schema Names Pascal Case OpenAPI
Schema Property Camel Case OpenAPI
Schema Property Camel Case 3 OpenAPI
Schema Property Constant Case OpenAPI
Schema Property Enum Upper Snake Case OpenAPI
Schema Property Kebab Case OpenAPI
Schema Property Names Camel Case OpenAPI
Schema Property Names Camel Case 2 OpenAPI
Schema Property Names Length Limit OpenAPI
Schema Property No Language Keywords OpenAPI
Schema Property No Prepositions OpenAPI
Schema Property Pascal Case OpenAPI
Schema Property Snake Case OpenAPI
Schema Require Name OpenAPI
Schema Use Fingerprint Not Hash OpenAPI
Schema Use ID Not Identifier OpenAPI
Schema Use Org Not Organization OpenAPI
Server URL Must Be Lowercase OpenAPI
Tag Names Title Case OpenAPI
Tag No Camel Case OpenAPI
Tag No Pascal Case OpenAPI
Tag No Version Info OpenAPI
Tag Require Name OpenAPI

← All experience rulesets