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
View Rules File View on GitHub

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

Spectral Ruleset

Raw ↑
# apache-httpd — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - operationid-casing: camel @ 100% (n=4)
#   - schema-names-casing: pascal @ 100% (n=4)
#   - schema-properties-casing: pascal @ 39% (n=28)
#   - merge: kept 7 existing, added 4 measured, upgraded 0
#   - added: operationid-casing, schema-names-casing, schema-properties-casing, no-empty-descriptions
extends:
  - spectral:oas
rules:
  httpd-operation-summary:
    description: All Apache httpd API operations must have a summary
    severity: error
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: summary
      function: truthy
  httpd-operation-id:
    description: All Apache httpd API operations must have an operationId
    severity: error
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: operationId
      function: truthy
  httpd-operation-tags:
    description: All Apache httpd API operations must have at least one tag
    severity: warn
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: tags
      function: truthy
  httpd-schema-description:
    description: All Apache httpd schema components must have a description
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  httpd-property-description:
    description: All Apache httpd schema properties should have descriptions
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: description
      function: truthy
  httpd-info-contact:
    description: API info must include contact information
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  httpd-info-license:
    description: API info must include license information
    severity: warn
    given: $.info
    then:
      field: license
      function: truthy
  operationid-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  schema-properties-casing:
    description: Schema properties should be PascalCase (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy