Apache OpenMeetings · API Governance Rules
Apache OpenMeetings API Rules
Spectral linting rules defining API design standards and conventions for Apache OpenMeetings.
17 Rules
error 4
warn 9
info 4
Rule Categories
info
no
operation
operationid
path
paths
query
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[*]
warn
path-params-casing
Path parameters should be snake_case (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be snake_case (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
info
operationid-casing
Operation IDs should be snake_case (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
operation-documents-500
Operations should document a 500 response (documented on 98% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description