AmTrust Financial Services · API Governance Rules
AmTrust Financial Services API Rules
Spectral linting rules defining API design standards and conventions for AmTrust Financial Services.
10 Rules
error 7
warn 3
Rule Categories
info
operation
parameter
response
schema
security
servers
Rules
warn
info-title-amtrust
API title must include AmTrust Financial Services
$.info.title
error
info-description-required
Info must have a description
$.info
error
servers-https-only
All servers must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have summaries
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
All operations must have operationIds
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
response-success-required
All operations must have success responses
$.paths[*][get,post,put,patch,delete].responses
error
security-schemes-defined
Security schemes must be defined
$.components
warn
schema-properties-typed
Schema properties should have explicit types
$.components.schemas[*].properties[*]