ERCOT · API Governance Rules
ERCOT API Rules
Spectral linting rules defining API design standards and conventions for ERCOT.
53 Rules
error 45
warn 7
info 1
Generated by API Evangelist
Written by API Evangelist tooling for ERCOT's APIs. It is a starting point, not a ruleset ERCOT publishes or enforces.
Rule Categories
info
list
mediatype
operation
parameter
path
property
response
root
schema
securityscheme
server
servers
tag
Rules
error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-tags
Every operation is tagged (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-success-response
Every operation declares a 2xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
operation-declares-4xx
Every operation declares at least one 4xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
operation-declares-401-or-403
Every operation declares 401 or 403 (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
root-security-declared
The contract declares security at the root (measured: 100% of this contract)
$
error
path-no-trailing-slash
Paths carry no trailing slash (measured: 100% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
error
servers-https
Servers are https (measured: 100% of this contract)
$.servers[*].url
warn
list-pagination-parameter
Collection GETs take the `page` pagination parameter (measured: 98% of this contract)
$.paths[?(@property.match(/[^}]$/))].get
error
response-media-type
Responses are served as application/json (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses[*].content
warn
property-name-casing-camel
Schema property names are camel case (measured: 97% of this contract)
$.components.schemas[*].properties[*]~
error
info-has-description
The contract's info block carries a description (measured: 100% of this contract)
$.info
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
warn
info-title-min-length
Info.title runs at least 58 characters (measured: 97% of this contract)
$.info.title
error
info-description-present
Info declares description (measured: 100% of this contract)
$.info
error
info-description-min-length
Info.description runs at least 102 characters (measured: 100% of this contract)
$.info.description
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
info-version-semver
info.version is numeric (measured: 100% of this contract)
$.info.version
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
error
server-url-https
Server.url is https (measured: 100% of this contract)
$.servers[*].url
error
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
warn
tag-description-present
Tag declares description (measured: 94% of this contract)
$.tags[*]
warn
tag-description-min-length
Tag.description runs at least 58 characters (measured: 97% of this contract)
$.tags[*].description
error
operation-tags-present
Operation declares tags (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
warn
operation-summary-min-length
Operation.summary runs at least 22 characters (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
error
operation-description-min-length
Operation.description runs at least 55 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].description
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
warn
operation-parameters-present
Operation declares parameters (measured: 98% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-responses-present
Operation declares responses (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
parameter-name-present
Parameter declares name (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-present
Parameter declares in (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-values
Parameter.in is one of query (measured: 99% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
error
parameter-description-present
Parameter declares description (measured: 99% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-description-min-length
Parameter.description runs at least 13 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
error
parameter-schema-present
Parameter declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
mediatype-schema-present
MediaType declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
error
mediatype-example-present
MediaType declares example (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
error
response-description-present
Response declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
response-description-min-length
Response.description runs at least 40 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].description
error
response-content-present
Response declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
schema-type-present
Schema declares type (measured: 100% of this contract)
$.components.schemas[*]
error
schema-type-values
Schema.type is one of object (measured: 100% of this contract)
$.components.schemas[*].type
info
schema-description-present
Schema declares description (measured: 85% of this contract)
$.components.schemas[*]
error
schema-description-min-length
Schema.description runs at least 29 characters (measured: 100% of this contract)
$.components.schemas[*].description
error
schema-properties-present
Schema declares properties (measured: 100% of this contract)
$.components.schemas[*]
error
securityscheme-type-present
SecurityScheme declares type (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-type-values
SecurityScheme.type is one of apiKey (measured: 100% of this contract)
$.components.securitySchemes[*].type
error
securityscheme-name-present
SecurityScheme declares name (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-in-present
SecurityScheme declares in (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-in-values
SecurityScheme.in is one of header, query (measured: 100% of this contract)
$.components.securitySchemes[*].in
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.