AT&T · API Governance Rules
AT&T API Rules
Spectral linting rules defining API design standards and conventions for AT&T.
37 Rules
error 16
warn 18
info 3
Rule Categories
delete
get
info
microcks
no
openapi
operation
parameter
paths
post
request
response
schema
security
servers
tags
Rules
warn
info-title-pattern
API title must start with "AT&T"
$.info.title
error
info-description-required
API info must have a non-empty description
$.info
error
info-version-required
API info must have a version
$.info
warn
info-contact-required
API info should have contact information
$.info
warn
info-terms-of-service
API info should include a termsOfService URL
$.info
error
openapi-version
Must use OpenAPI 3.0.x
$.openapi
error
servers-required
At least one server must be defined
$
error
servers-https-only
All 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 (lowercase with hyphens)
$.paths
warn
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-att-prefix
Operation summaries must start with "AT&T"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-operationid-camel-case
operationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
tags-global-defined
Global tags array should be defined
$
error
parameter-description-required
Every parameter must have a description
$.paths[*][*].parameters[*]
error
parameter-schema-required
Every parameter must have a schema
$.paths[*][*].parameters[*]
info
parameter-snake-case
Query and header parameter names should use snake_case or camelCase
$.paths[*][*].parameters[?(@.in == 'query')].name
warn
request-body-description
Request bodies should have a description
$.paths[*][post,put,patch].requestBody
warn
request-body-json-content
Request bodies should support application/json
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have at least one 2xx response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Every response must have a description
$.paths[*][*].responses[*]
warn
response-401-required
Operations using security should have a 401 response
$.paths[*][get,post,put,patch,delete][?(@.security)]
warn
response-400-for-post
POST operations should document a 400 Bad Request response
$.paths[*].post
warn
schema-description-required
Top-level component schemas should have descriptions
$.components.schemas[*]
warn
schema-properties-types
Schema properties should have a type defined
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined in components
$.components
warn
security-oauth2-scopes
OAuth2 security schemes must define scopes
$.components.securitySchemes[?(@.type == 'oauth2')].flows[*]
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
warn
post-has-request-body
POST operations should have a request body
$.paths[*].post
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-examples-encouraged
Operations should include request/response examples for Microcks compatibility
$.paths[*][get,post,put,patch,delete].responses[*].content[*]
info
microcks-operation-extension
Operations should include x-microcks-operation extension for mock server support
$.paths[*][get,post,put,patch,delete]