Apache Pinot · API Governance Rules
Apache Pinot API Rules
Spectral linting rules defining API design standards and conventions for Apache Pinot.
11 Rules
error 5
warn 4
info 2
Rule Categories
info
no
operation
operationid
path
response
schema
servers
Rules
error
info-title-required
$.info
error
operation-summary-required
$.paths[*][*]
error
operation-operationId-required
$.paths[*][*]
info
operation-summary-apache-prefix
$.paths[*][get,post,put,delete,patch].summary
error
response-success-required
$.paths[*][get,post,put].responses
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be camelCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description