Apache OpenNLP · API Governance Rules
Apache OpenNLP API Rules
Spectral linting rules defining API design standards and conventions for Apache OpenNLP.
10 Rules
error 4
warn 5
info 1
Rule Categories
info
operation
paths
request
response
schema
Rules
error
info-title-required
API must have a title
$.info
warn
info-description-required
API must have a description
$.info
error
operation-summary-required
Operations must have summaries
$.paths[*][*]
error
operation-operationId-required
Operations must have operationIds
$.paths[*][*]
warn
operation-tags-required
Operations must have tags
$.paths[*][*]
info
operation-summary-apache-prefix
Summaries should start with Apache OpenNLP
$.paths[*][get,post,put,delete,patch].summary
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
request-body-content-type
Request bodies should use application/json
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Operations must have a 200 success response
$.paths[*][*].responses
warn
schema-type-defined
Schema properties should have types defined
$.components.schemas[*].properties[*]