Battle.net · API Governance Rules
Battle.net API Rules
Spectral linting rules defining API design standards and conventions for Battle.net.
30 Rules
error 14
warn 15
info 1
Rule Categories
delete
get
info
openapi
operation
parameter
paths
response
schema
security
servers
tags
Rules
warn
info-title-format
API title must start with "Battle.net"
$.info.title
error
info-description-required
API info must have a description with minimum 50 characters
$.info
error
info-version-required
API must have a version defined
$.info
warn
info-contact-required
API info should include contact information
$.info
warn
openapi-version
OpenAPI version must be 3.0.x
$.openapi
error
servers-defined
API must define at least one server
$
error
servers-https-only
Server URLs must use HTTPS
$.servers[*].url
warn
servers-description-required
Each server should have a description
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have a trailing slash
$.paths[*]~
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with "Battle.net"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
All operations must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
All operations 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
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
tags-global-defined
API must define global tags
$
warn
tags-description-required
All global tags should have descriptions
$.tags[*]
error
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
All parameters must have a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
All operations must have at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-required
All operations should document 401 Unauthorized responses
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
schema-properties-type-defined
Schema properties should have a type defined
$.components.schemas[*].properties[*]
error
security-schemes-defined
API must define security schemes
$.components
warn
security-global-defined
API must have global security defined
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
info
operation-examples-encouraged
Operations should include examples in responses
$.paths[*][get,post,put,patch,delete].responses[*].content[*]