Harness · API Governance Rules
Harness API Rules
Spectral linting rules defining API design standards and conventions for Harness.
8 Rules
error 4
warn 3
info 1
Rule Categories
info
operation
parameter
response
schema
security
Rules
warn
info-title-prefix
Info title should start with "Harness"
$.info
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary starting with "Harness"
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Operations must have success responses
$.paths[*][get,post,put,patch,delete].responses
error
security-global-defined
Global security must be defined
$
info
schema-properties-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]