Apache Ranger · API Governance Rules
Apache Ranger API Rules
Spectral linting rules defining API design standards and conventions for Apache Ranger.
15 Rules
error 5
warn 9
info 1
Rule Categories
apache
no
operationid
path
query
schema
security
servers
Rules
error
apache-ranger-info-title-required
Info object must have a title
$.info
error
apache-ranger-operation-summary-required
All operations must have a summary
$.paths[*][*]
error
apache-ranger-operation-operationId-required
All operations must have an operationId
$.paths[*][*]
warn
apache-ranger-operation-tags-required
All operations must have tags
$.paths[*][*]
warn
apache-ranger-operation-summary-apache-prefix
Operation summaries should be prefixed with Apache Ranger
$.paths[*][*].summary
error
apache-ranger-response-success-required
All operations must have a success response
$.paths[*][*].responses
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the example.com domain.
$.servers[*].url
warn
path-params-casing
Path parameters should be snake_case (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
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
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description