Apache Ignite · API Governance Rules
Apache Ignite API Rules
Spectral linting rules defining API design standards and conventions for Apache Ignite.
23 Rules
error 10
warn 9
info 4
Rule Categories
examples
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
Rules
error
info-title-required
Info title must be present and start with Apache Ignite
$.info
warn
info-description-required
Info must have a description
$.info
error
info-version-required
Info must have a version field
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-defined
Servers must be defined
$
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-prefix
Operation summaries should start with Apache Ignite
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-description-required
Every operation should have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
Parameters should have descriptions
$.paths[*][get,post,put,patch,delete,head,options].parameters[*]
error
response-success-required
Every operation must have at least one 2xx response
$.paths[*][get,post,put,patch,delete,head,options].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete,head,options].responses[*]
info
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty
$..description
warn
security-schemes-defined
Security schemes should be defined
$.components
info
response-error-400
POST/PUT operations should document 400 responses
$.paths[*][post,put].responses
info
response-error-404
GET operations should document 404 responses
$.paths[*].get.responses
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
info
examples-encouraged
Schema properties should include examples
$.components.schemas[*].properties[*]