AT&T Developer Hub · API Governance Rules
AT&T Developer Hub API Rules
Spectral linting rules defining API design standards and conventions for AT&T Developer Hub.
26 Rules
error 14
warn 9
info 3
Rule Categories
camara
get
info
microcks
no
openapi
operation
parameter
paths
post
response
schema
security
servers
Rules
warn
info-title-pattern
API title must start with "AT&T"
$.info.title
error
info-description-required
API info must have a description
$.info
error
info-version-required
API info must have a version
$.info
warn
info-contact-required
API info should have contact information
$.info
error
openapi-version-3
Must use OpenAPI 3.0.x
$.openapi
error
servers-required
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-att-prefix
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]
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camelcase
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]
warn
camara-error-schema
API should define an ErrorInfo schema in components for CAMARA compliance
$.components.schemas
info
camara-phone-number-e164
Phone number parameters should document E.164 format requirement
$.components.schemas[*].properties.phoneNumber
error
parameter-description-required
Every parameter must have a description
$.paths[*][*].parameters[*]
error
response-description-required
Every response must have a description
$.paths[*][*].responses[*]
warn
response-401-defined
Operations using security should document 401 responses
$.paths[*][post,get,delete][?(@.security)]
info
response-429-defined
Operations should document 429 Too Many Requests responses for rate limiting
$.paths[*][post]
warn
schema-description-required
Component schemas should have descriptions
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
post-has-request-body
POST operations should have a request body
$.paths[*].post
info
microcks-operation-extension
Operations should include x-microcks-operation for mock server support
$.paths[*][post,get,delete]
error
no-empty-descriptions
Descriptions must not be empty strings
$..description