experience-consistency.html

Uniform shapes, conventions, and structure so every endpoint behaves predictably.

304 rules experience: consistency 248 inlined · 56 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-consistency.spotlight.yaml

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

Ruleset definition

Loading…

Rules in this ruleset (304)

Skill Description Single Line Agent Skill

Skill Single Title Agent Skill

API Property Require Linting Rules APIs.json

API Property Require Valid URL APIs.json

API Property Require Vocabulary APIs.json

API Tag Require Upper Case APIs.json

Info APIs JSON Specification Version Format APIs.json

Maintainer Email Format APIs.json

Tag Require Upper Case APIs.json

Arazzo Source Descriptions Type Arazzo engine

Arazzo Step OperationPath Arazzo engine

Arazzo Step Output Validation Arazzo engine

Arazzo Step StepId Arazzo engine

Arazzo Step Success Actions 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 Workflow WorkflowId Arazzo engine

Arazzo WorkflowId Unique Arazzo engine

Source Arazzo Description Require Name Arazzo

Workflow Arazzo Step Require Operation Arazzo

Asyncapi 3 Channel No Empty Parameter AsyncAPI engine

Asyncapi 3 Channel No Query Nor Fragment AsyncAPI engine

Asyncapi 3 Channel No Trailing Slash AsyncAPI engine

Asyncapi 3 Channel Servers AsyncAPI engine

Asyncapi 3 Server No Empty Variable AsyncAPI engine

Asyncapi 3 Server No Trailing Slash AsyncAPI engine

Asyncapi 3 Tags Alphabetical AsyncAPI engine

Asyncapi 3 Tags Uniqueness AsyncAPI engine

Asyncapi Channel No Empty Parameter AsyncAPI engine

Asyncapi Channel No Query Nor Fragment AsyncAPI engine

Asyncapi Channel No Trailing Slash AsyncAPI engine

Asyncapi Channel Parameters AsyncAPI engine

Asyncapi Channel Servers AsyncAPI engine

Asyncapi Latest Version AsyncAPI engine

Asyncapi Message MessageId Uniqueness AsyncAPI engine

Asyncapi Operation OperationId AsyncAPI engine

Asyncapi Operation OperationId Uniqueness AsyncAPI engine

Asyncapi Server No Empty Variable AsyncAPI engine

Asyncapi Server No Trailing Slash AsyncAPI engine

Asyncapi Server Variables AsyncAPI engine

Asyncapi Tags Alphabetical AsyncAPI engine

Asyncapi Tags Uniqueness AsyncAPI engine

Asyncapi Unused Components Schema AsyncAPI engine

Asyncapi Unused Components Server AsyncAPI engine

Component Asyncapi Message Require Contenttype AsyncAPI

Component Asyncapi Message Require Name AsyncAPI

Schema Asyncapi Property Camel Case AsyncAPI

Document FinOps Currency Iso4217 FinOps

Document FinOps Require Period FinOps

Document JSON LD ID IRI JSON-LD

Schema JSON LD Context URI Or Object JSON-LD

Document Require ID JSON Schema

Document Require Property JSON Schema

Document Require Required List JSON Schema

Document Require Type JSON Schema

Schema Property Require Type JSON Schema

Schema Require JSON Schema

Document JSON Structure ID URI JSON Structure

Document Require ID JSON Structure

Document Require Name JSON Structure

Document Require Property JSON Structure

Document Require Type JSON Structure

Schema JSON Structure Property Camel Case JSON Structure

Schema JSON Structure URI JSON Structure

Schema Property Require Type JSON Structure

Schema Require JSON Structure

Document MCP Name Kebab Case MCP

Info MCP Protocol Version Dated MCP

Info Require Protocol Version MCP

Component Example Keys Snake Case OpenAPI

Document Require Component Section OpenAPI

Duplicated Entry In Enum OpenAPI engine

Header Names Hyphenated Pascal Case OpenAPI

Header No X Prefix OpenAPI

Info Description Length Limit OpenAPI

Info Microcks Extension Valid OpenAPI

Info Title Capitalized OpenAPI

Info Title Max Length OpenAPI

Info Version Must Be Semver OpenAPI

Info Version Must Use Semver OpenAPI

Info Version Semantic And Stable OpenAPI

Limit Nested Sub Resources OpenAPI

Limit Path Length OpenAPI

Limit Path Parameter OpenAPI

No $ref Siblings OpenAPI engine

OAS3 Callbacks In Callbacks OpenAPI engine

OAS3 Examples Value Or ExternalValue OpenAPI engine

OAS3 Server Trailing Slash OpenAPI engine

OAS3 Server Variables OpenAPI engine

OAS3 Unused Component OpenAPI engine

OAS3.1 Callbacks In Webhook OpenAPI engine

OAS3.1 Servers In Webhook OpenAPI engine

Openapi Tags Alphabetical OpenAPI engine

Openapi Tags Uniqueness OpenAPI engine

Operation Description Max Length OpenAPI

Operation ID Camel Case OpenAPI

Operation ID URL Safe OpenAPI

Operation Microcks Extension Valid OpenAPI

Operation Mutation Support Idempotency Key OpenAPI

Operation OperationId OpenAPI engine

Operation OperationId Unique OpenAPI engine

Operation Parameters OpenAPI engine

Operation Patch Must Have Request Body OpenAPI

Operation Post Not For Retrieval OpenAPI

Operation Post Require Request Body OpenAPI

Operation Put Require Request Body OpenAPI

Operation Ref Resource File OpenAPI

Operation Require ID OpenAPI

Operation Require Identifier OpenAPI

Operation Require One Tag OpenAPI

Operation Require Response OpenAPI

Operation Security Use Defined Scheme OpenAPI

Operation Singular Tag OpenAPI engine

Operation Summary Max Length OpenAPI

Operation Summary No Period OpenAPI

Operation Tag Defined OpenAPI engine

Operation Tag Title Case OpenAPI

Operation Use Ref OpenAPI

Operation Well Understood Status Codes OpenAPI

Parameter Array Require Items OpenAPI

Parameter Array Typed Items OpenAPI

Parameter Description Max Length OpenAPI

Parameter Enum Upper Snake Case OpenAPI

Parameter Filter Param Only On Get OpenAPI

Parameter Keys Snake Case OpenAPI

Parameter Name Max Length OpenAPI

Parameter Names Camel Case OpenAPI

Parameter No Forbidden HTTP Header OpenAPI

Parameter No Hybrid And Root Filtering OpenAPI

Parameter No ID Query OpenAPI

Parameter No X Prefixed Request Header OpenAPI

Parameter Pagination Params In Query OpenAPI

Parameter Query Allowed Characters OpenAPI

Parameter Query Camel Case OpenAPI

Parameter Query Must Be Optional OpenAPI

Parameter Schema Require Type OpenAPI

Parameter Schema Use Ref OpenAPI

Parameter Sort Param Only On Get OpenAPI

Path Declarations Must Exist OpenAPI engine

Path Delete No Response Body OpenAPI

Path Get Response Support JSON OpenAPI

Path Include Version OpenAPI

Path Keys No Trailing Slash OpenAPI engine

Path Max Nesting Depth OpenAPI

Path No API Prefix In OpenAPI

Path No Empty Segment 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 Trailing Slash OpenAPI

Path No Trailing Slash In OpenAPI

Path No Verbs OpenAPI

Path No Version Segment 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 Not Empty OpenAPI

Path Parameter Pascal Case OpenAPI

Path Parameter Snake Case OpenAPI

Path Params OpenAPI engine

Path Params Declared In Block OpenAPI

Path Require Query Parameter OpenAPI

Path Require Valid HTTP Verb OpenAPI

Path Resources Plural OpenAPI

Path Segment Kebab Case OpenAPI

Path URI Versioning Single Version OpenAPI

Path Use Standard HTTP Methods OpenAPI

Path Write Response Support JSON OpenAPI

Request Body Must Use JSON Content Type OpenAPI

Request Delete Must Not Have Body OpenAPI

Request Delete No Body OpenAPI

Request Get Must Not Have Body OpenAPI

Request Get No Body OpenAPI

Request Head Must Not Have Body OpenAPI

Request Header Names Pascal Case OpenAPI

Request Options Must Not Have Body OpenAPI

Request Patch Media Type Not Plain JSON OpenAPI

Request Property Names Camel Case OpenAPI

Request Support Accept Language OpenAPI

Request Support Form Urlencoded Media Type OpenAPI

Request Support JSON Media Type OpenAPI

Request Support JSON Media Type 2 OpenAPI

Request Support Multipart Media Type OpenAPI

Request Support Text Plain Media Type OpenAPI

Request Support XML Media Type OpenAPI

Response 206 Require Content Range OpenAPI

Response Body Must Be Object OpenAPI

Response Cache Header No Conflict OpenAPI

Response Code Must Be Valid OpenAPI

Response Custom Header Naming Format OpenAPI

Response Default Content Language En Us OpenAPI

Response Delete 404 Use Schema Ref OpenAPI

Response Delete Codes Allowed OpenAPI

Response Delete Define 204 OpenAPI

Response Delete Must Not Return Body OpenAPI

Response Delete Require 204 OpenAPI

Response Error Match Problem Schema OpenAPI

Response Error Schema Problem Property Names OpenAPI

Response Error Standard Payload OpenAPI

Response Error Use Problem JSON OpenAPI

Response Error Use Problem Type OpenAPI

Response Error Use Problem Type 2 OpenAPI

Response Get Codes Allowed OpenAPI

Response Get Define 200 OpenAPI

Response Get Must Return 200 OpenAPI

Response Get Must Return Body OpenAPI

Response Head Codes Allowed OpenAPI

Response Head Must Not Return Body OpenAPI

Response Header Names Pascal Case OpenAPI

Response Header No X Prefix OpenAPI

Response Keys Snake Case OpenAPI

Response Location Header Only On 201 OpenAPI

Response Must Use JSON Content Type OpenAPI

Response Names Pascal Case OpenAPI

Response No Operational Header In Spec OpenAPI

Response Options Codes Allowed OpenAPI

Response Options Must Not Return Body OpenAPI

Response Patch Codes Allowed OpenAPI

Response Post Codes Allowed OpenAPI

Response Post Define 201 OpenAPI

Response Post Require 201 Or 202 OpenAPI

Response Prefer 400 Over 422 OpenAPI

Response Put Codes Allowed OpenAPI

Response Success Use HAL JSON OpenAPI

Response Use JSON API OpenAPI

Response Use Standard Mime Types OpenAPI

Response Use Standard Status Codes OpenAPI

Response Use Standard Status Codes 2 OpenAPI

Response Write Require Content Type OpenAPI

Schema Array Property Require Items OpenAPI

Schema Array Property Typed Items OpenAPI

Schema Boolean No Prefix OpenAPI

Schema Created Datetime Must Be Date Time OpenAPI

Schema Createdby Property Must Be String OpenAPI

Schema Date Time Property Require Format 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 Deletedby Property Must Be String OpenAPI

Schema Description Max Length 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 Keys Snake Case OpenAPI

Schema Modified Datetime Must Be Date Time OpenAPI

Schema Modifiedby Property Must Be String OpenAPI

Schema Name Max Length OpenAPI

Schema Name Property Must Be String OpenAPI

Schema Names Pascal Case OpenAPI

Schema Number Format Allowed Values OpenAPI

Schema Number Require Format OpenAPI

Schema Orgid Property Must Be String OpenAPI

Schema Property Camel Case OpenAPI

Schema Property Camel Case 3 OpenAPI

Schema Property Constant Case OpenAPI

Schema Property Description Max Length 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 Require Type OpenAPI

Schema Property Snake Case 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 Tag Object OpenAPI

Schema Require Type OpenAPI

Schema Use Fingerprint Not Hash OpenAPI

Schema Use ID Not Identifier OpenAPI

Schema Use Org Not Organization OpenAPI

Server Must Not Specify Port OpenAPI

Server On Approved Domain OpenAPI

Server URL Include Version OpenAPI

Server URL Meet Standards OpenAPI

Server URL Must Be Lowercase OpenAPI

Tag Names Title Case OpenAPI

Tag No Camel Case OpenAPI

Tag No Pascal Case OpenAPI

Tag Require At Least One OpenAPI

Typed Enum OpenAPI engine

Plan Currency Iso4217 Plans

Plan Require Interval Plans

Limit Scope Known Rate Limits

Limit Window Format Rate Limits

← All experience rulesets