Architect of the Capitol · API Governance Rules
Architect of the Capitol API Rules
Spectral linting rules defining API design standards and conventions for Architect of the Capitol.
13 Rules
error 8
warn 5
Rule Categories
aoc
Rules
error
aoc-building-id-required
Building responses must include an id field
$.components.schemas.Building.properties
error
aoc-building-name-required
Building responses must include a name field
$.components.schemas.Building.properties
error
aoc-artwork-title-required
Artwork responses must include a title field
$.components.schemas.Artwork.properties
error
aoc-artwork-artist-required
Artwork responses must include an artist field
$.components.schemas.Artwork.properties
error
aoc-preservation-status-enum
Preservation project status must be a valid enum value
$.components.schemas.PreservationProject.properties.status
warn
aoc-list-responses-have-total
List responses must include a total count
$.components.schemas[*List].properties
warn
aoc-list-responses-have-limit
List responses must include a limit field
$.components.schemas[*List].properties
warn
aoc-operations-have-tags
All API operations must have tags
$.paths[*][get,post,put,patch,delete]
error
aoc-operations-have-summary
All API operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
aoc-operations-have-operation-id
All API operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
aoc-path-parameters-described
Path parameters must have descriptions
$.paths[*][*].parameters[?(@.in=='path')]
warn
aoc-info-contact-required
API info must include contact information
$.info
error
aoc-servers-defined
API must define at least one server
$