Apache OpenMeetings · API Governance Rules
Apache OpenMeetings API Rules
Spectral linting rules defining API design standards and conventions for Apache OpenMeetings.
10 Rules
error 4
warn 4
info 2
Rule Categories
info
operation
paths
response
schema
servers
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[*][*]
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
info
operation-summary-apache-prefix
Operation summaries should start with Apache OpenMeetings
$.paths[*][get,post,put,delete,patch].summary
warn
servers-https
Servers should use HTTPS
$.servers[*].url
error
response-success-required
Operations must have a success response
$.paths[*][*].responses
info
schema-properties-described
Schema properties should have descriptions
$.components.schemas[*].properties[*]