Amazon API Gateway · API Governance Rules

Amazon API Gateway API Rules

Spectral linting rules defining API design standards and conventions for Amazon API Gateway.

5 Rules error 4 info 1
View Rules File View on GitHub

Rule Categories

amazon

Rules

error
amazon-info-title-required
API must have a title.
$.info
error
amazon-operation-summary-required
Operations must have summaries.
$.paths[*][get,post,put,patch,delete]
error
amazon-operation-operationid-required
Operations must have operationIds.
$.paths[*][get,post,put,patch,delete]
error
amazon-response-200-get
GET operations must return 200.
$.paths[*].get
info
amazon-schema-description
Schemas should have descriptions.
$.components.schemas[*]