Apache EventMesh · API Governance Rules
Apache EventMesh API Rules
Spectral linting rules defining API design standards and conventions for Apache EventMesh.
10 Rules
error 4
warn 5
info 1
Rule Categories
info
operation
parameter
paths
response
schema
Rules
error
info-title-required
Info title must be defined
$.info
error
info-version-required
API version must be specified
$.info
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-apache-eventmesh-prefix
Operation summaries should start with Apache EventMesh
$.paths[*][get,post,put,delete,patch].summary
error
operation-operationId-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,delete,patch].parameters[*]
warn
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]