Apache James · API Governance Rules
Apache James API Rules
Spectral linting rules defining API design standards and conventions for Apache James.
20 Rules
error 9
warn 7
info 4
Rule Categories
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
Rules
warn
info-title-prefix
Info title should start with Apache James
$.info
warn
info-description-required
Info must have a description
$.info
error
info-version-required
Info must have a version
$.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]
warn
operation-summary-prefix
Summaries should start with Apache James WebAdmin
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Responses must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
error
get-no-request-body
GET operations must not have request bodies
$.paths[*].get
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
error
response-2xx-required
Every operation must have a 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
security-schemes-defined
Security schemes should be defined
$.components
warn
no-empty-descriptions
Descriptions must not be empty
$..description
warn
parameter-description-required
Parameters should have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
info
schema-description-required
Component schemas should have descriptions
$.components.schemas[*]
info
response-error-404
GET operations should document 404 responses
$.paths[*].get.responses
info
response-error-400
POST operations should document 400 responses
$.paths[*].post.responses
info
operation-description-recommended
Operations should have descriptions
$.paths[*][get,post,put,patch,delete]