Amazon PrivateLink · API Governance Rules
Amazon PrivateLink API Rules
Spectral linting rules defining API design standards and conventions for Amazon PrivateLink.
16 Rules
error 11
warn 5
Rule Categories
info
no
openapi
operation
response
schema
security
servers
Rules
error
info-title-required
API must have a title
$.info
error
info-description-required
API must have a description
$.info
error
info-version-required
API version must be defined
$.info
error
openapi-version-3
API should use OpenAPI 3.x
$.openapi
error
servers-defined
Servers must be defined
$
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-amazon-privatelink-prefix
Summaries should start with Amazon PrivateLink
$.paths[*][get,post,put,delete,patch].summary
error
operation-description-required
All operations must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,delete,patch]
error
response-success-required
All operations must have a success response
$.paths[*][get,post,put,delete,patch]
error
response-description-required
All responses must have descriptions
$.paths[*][*].responses[*]
warn
schema-type-defined
Schemas should define a type
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined
$.components
warn
security-global-defined
Global security must be defined
$
warn
no-empty-descriptions
Descriptions must not be empty
$..description