Apache HttpComponents · API Governance Rules

Apache HttpComponents API Rules

Spectral linting rules defining API design standards and conventions for Apache HttpComponents.

7 Rules error 2 warn 4 info 1
View Rules File View on GitHub

Rule Categories

http

Rules

error
http-client-operation-summary
All Apache HttpComponents API operations must have a summary
$.paths[*][get,put,post,delete,patch]
error
http-client-operation-id
All Apache HttpComponents API operations must have an operationId
$.paths[*][get,put,post,delete,patch]
warn
http-client-operation-tags
All Apache HttpComponents API operations must have at least one tag
$.paths[*][get,put,post,delete,patch]
warn
http-client-schema-description
All Apache HttpComponents schema components must have a description
$.components.schemas[*]
info
http-client-property-description
All Apache HttpComponents schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
http-client-info-contact
API info must include contact information
$.info
warn
http-client-info-license
API info must include license information
$.info