Amazon Ground Station · API Governance Rules
Amazon Ground Station API Rules
Spectral linting rules defining API design standards and conventions for Amazon Ground Station.
15 Rules
error 5
warn 8
info 2
Rule Categories
info
microcks
no
operation
operationid
path
query
response
schema
security
servers
Rules
warn
info-title-format
$.info.title
error
info-description-required
$.info
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-company-prefix
$.paths[*][get,post,put,patch,delete].summary
error
response-success-required
$.paths[*][get,post,put,patch,delete].responses
error
no-empty-descriptions
$..description
info
microcks-operation-extension
$.paths[*][get,post,put,patch,delete]
warn
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be camelCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components