GitHub · API Governance Rules
GitHub API Rules
Spectral linting rules defining API design standards and conventions for GitHub.
20 Rules
error 14
warn 3
info 3
Rule Categories
get
info
no
operation
parameter
paths
response
security
servers
tags
Rules
error
info-title-required
$.info
warn
info-title-format
$.info.title
error
info-description-required
$.info
error
info-version-required
$.info
error
servers-defined
$
error
servers-https-only
$.servers[*].url
error
paths-no-trailing-slash
$.paths
info
paths-kebab-case
Path segments should use kebab-case or snake_case.
$.paths
error
operation-description-required
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-unique
$
warn
operation-tags-required
$.paths[*][get,post,put,patch,delete]
info
tags-title-case
$.tags[*].name
error
parameter-description-required
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-snake-case
Parameter names should use snake_case (GitHub convention).
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
$.paths[*][get,post,put,patch,delete].responses[*]
warn
security-schemes-defined
$.components
error
get-no-request-body
$.paths[*].get
error
no-empty-descriptions
$..description