activision-blizzard · API Governance Rules
activision-blizzard API Rules
Spectral linting rules defining API design standards and conventions for activision-blizzard.
23 Rules
error 9
warn 12
info 2
Rule Categories
http
info
openapi
operation
parameter
paths
response
schema
security
servers
Rules
warn
info-title-format
API title should start with "Activision Blizzard" or "Battle.net"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must include a version
$.info
warn
openapi-version
Should use OpenAPI 3.x
$.openapi
error
servers-defined
At least one server must be defined
$
warn
servers-https
All servers should use HTTPS
$.servers[*].url
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summary should start with "Activision Blizzard"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation should have a description
$.paths[*][get,post,put,patch,delete]
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationId-camelCase
OperationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-namespace-required
Battle.net data endpoints require namespace parameter
$.paths[/data/**][get].parameters
error
response-success-required
Every operation must have a 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-defined
Operations should document 401 Unauthorized
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
error
security-schemes-defined
Security schemes must be defined in components
$.components
warn
security-oauth2
Battle.net API should use OAuth2 authentication
$.components.securitySchemes[*].type
error
http-get-no-request-body
GET operations should not have a request body
$.paths[*].get
warn
schema-description-required
Component schemas should have descriptions
$.components.schemas[*]
info
schema-property-examples
Schema properties should have example values
$.components.schemas[*].properties[*]