Apache HTTP Server · API Governance Rules
Apache HTTP Server API Rules
Spectral linting rules defining API design standards and conventions for Apache HTTP Server.
11 Rules
error 2
warn 7
info 2
Rule Categories
httpd
no
operationid
schema
Rules
error
httpd-operation-summary
All Apache httpd API operations must have a summary
$.paths[*][get,put,post,delete,patch]
error
httpd-operation-id
All Apache httpd API operations must have an operationId
$.paths[*][get,put,post,delete,patch]
warn
httpd-operation-tags
All Apache httpd API operations must have at least one tag
$.paths[*][get,put,post,delete,patch]
warn
httpd-schema-description
All Apache httpd schema components must have a description
$.components.schemas[*]
info
httpd-property-description
All Apache httpd schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
httpd-info-contact
API info must include contact information
$.info
warn
httpd-info-license
API info must include license information
$.info
warn
operationid-casing
Operation IDs should be camelCase (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 PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description