Amazon GameLift · API Governance Rules
Amazon GameLift API Rules
Spectral linting rules defining API design standards and conventions for Amazon GameLift.
18 Rules
error 7
warn 8
info 3
Rule Categories
info
microcks
no
openapi
operation
request
response
schema
security
servers
Rules
warn
info-title-format
API title must start with "Amazon GameLift"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
openapi-version
Must use OpenAPI 3.0.x
$.openapi
error
servers-required
Servers must be defined
$
warn
servers-https
Server URLs should use HTTPS
$.servers[*].url
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-company-prefix
Operation summaries must start with Amazon GameLift
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camel-case
operationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
response-success-required
Operations must have at least one success (2xx) response
$.paths[*][get,post,put,patch,delete].responses
warn
response-description-required
Responses must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
info
request-body-description
Request bodies should have descriptions
$.paths[*][post,put,patch].requestBody
warn
security-schemes-defined
Security schemes should be defined in components
$
info
schema-properties-typed
Schema properties should have types defined
$.components.schemas[*].properties[*]
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
microcks-operation-extension
Operations should have x-microcks-operation for mock support
$.paths[*][get,post,put,patch,delete]