Architectural Design Patterns · API Governance Rules
Architectural Design Patterns API Rules
Spectral linting rules defining API design standards and conventions for Architectural Design Patterns.
12 Rules
error 8
warn 4
Rule Categories
adp
Rules
error
adp-pattern-id-required
Pattern must have an id field
$.components.schemas.Pattern.properties
error
adp-pattern-name-required
Pattern must have a name field
$.components.schemas.Pattern.properties
error
adp-pattern-description-required
Pattern must have a description field
$.components.schemas.Pattern.properties
error
adp-relationship-type-enum
Relationship type must be a valid enum value
$.components.schemas.Relationship.properties.relationshipType
warn
adp-category-enum
Pattern category must be a valid enum value
$.paths./patterns.get.parameters[?(@.name=='category')].schema
warn
adp-operations-have-tags
All API operations must have tags
$.paths[*][get,post,put,patch,delete]
error
adp-operations-have-summary
All API operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
adp-operations-have-operation-id
All API operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
adp-list-responses-have-total
List responses must include a total count
$.components.schemas[*List].properties
error
adp-anti-pattern-name-required
Anti-pattern must have a name field
$.components.schemas.AntiPattern.properties
warn
adp-info-contact-required
API info must include contact information
$.info
error
adp-servers-defined
API must define at least one server
$