Architecture Pattern · API Governance Rules
Architecture Pattern API Rules
Spectral linting rules defining API design standards and conventions for Architecture Pattern.
12 Rules
error 7
warn 5
Rule Categories
ap
Rules
error
ap-pattern-id-required
Pattern must have an id field
$.components.schemas.Pattern.properties
error
ap-pattern-name-required
Pattern must have a name field
$.components.schemas.Pattern.properties
warn
ap-pattern-problem-required
Pattern must have a problem statement
$.components.schemas.Pattern.properties
warn
ap-pattern-solution-required
Pattern must have a solution description
$.components.schemas.Pattern.properties
error
ap-pattern-confidence-enum
Pattern confidence must be a valid enum value
$.components.schemas.Pattern.properties.confidence
error
ap-tradeoff-severity-enum
Tradeoff severity must be a valid enum value
$.components.schemas.Tradeoff.properties.severity
warn
ap-list-responses-have-total
List responses must include a total count
$.components.schemas[*List].properties
warn
ap-operations-have-tags
All API operations must have tags
$.paths[*][get,post,put,patch,delete]
error
ap-operations-have-summary
All API operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
ap-operations-have-operation-id
All API operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
ap-info-contact-required
API info must include contact information
$.info
error
ap-servers-defined
API must define at least one server
$