Amazon Device Farm · API Governance Rules
Amazon Device Farm API Rules
Spectral linting rules defining API design standards and conventions for Amazon Device Farm.
24 Rules
error 12
warn 8
info 4
Rule Categories
external
get
info
no
openapi
operation
parameter
post
response
schema
security
servers
Rules
warn
info-title-prefix
API title should include "Device Farm"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
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-id-pascal-case
OperationIds should use PascalCase (AWS Device Farm convention)
$.paths[*][get,post,put,delete,patch].operationId
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
error
parameter-schema-required
All parameters must have a schema
$.paths[*][get,post,put,delete,patch].parameters[*]
info
post-should-have-request-body
POST operations should typically have a request body
$.paths[*].post
error
response-success-required
Operations must have at least one 2xx response
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
info
response-error-4xx
Operations should document 4xx error responses
$.paths[*][get,post,put,delete,patch].responses
info
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
schema-type-required
Schemas should have a type defined
$.components.schemas[*]
warn
security-global-defined
Global security should be defined
$
warn
security-schemes-defined
Security schemes should be defined in components
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
external-docs-encouraged
API should reference external documentation
$