Airbus OneAtlas · API Governance Rules
Airbus OneAtlas API Rules
Spectral linting rules defining API design standards and conventions for Airbus OneAtlas.
12 Rules
error 4
warn 8
Rule Categories
oneatlas
Rules
warn
oneatlas-operation-summary-title-case
All operation summaries must use Title Case
$.paths[*][get,post,put,patch,delete]
error
oneatlas-require-operation-id
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
oneatlas-require-operation-tags
All operations must have tags
$.paths[*][get,post,put,patch,delete]
error
oneatlas-require-response-200
GET operations must define a 200 response
$.paths[*].get
warn
oneatlas-schema-title-required
Component schemas must have a title
$.components.schemas[*]
error
oneatlas-require-api-key-security
All operations must include API key security
$
error
oneatlas-require-server-url
API must define at least one server
$
warn
oneatlas-require-info-description
API info must have a description
$.info
warn
oneatlas-require-external-docs
API should reference external documentation
$
warn
oneatlas-require-operation-description
All operations must have a description
$.paths[*][get,post,put,patch,delete]
warn
oneatlas-geometry-type-required
Geometry schemas must specify a type field
$.components.schemas[?(@.description =~ /.*[Gg]eometr.*/)]
warn
oneatlas-catalog-item-required-fields
CatalogItem schema must include id and geometry
$.components.schemas.CatalogItem.properties