AT&T · API Governance Rules
AT&T API Rules
Spectral linting rules defining API design standards and conventions for AT&T.
27 Rules
error 13
warn 14
Rule Categories
atandt
Rules
error
atandt-info-title-required
AT&T APIs must have a title in the info object
$.info
error
atandt-info-description-required
AT&T APIs must include a description
$.info
error
atandt-info-version-required
AT&T APIs must specify a version
$.info
warn
atandt-info-contact-required
AT&T APIs must include contact information
$.info
warn
atandt-info-terms-required
AT&T APIs must include terms of service
$.info
error
atandt-openapi-version
AT&T APIs must use OpenAPI 3.0.x
$
error
atandt-servers-required
AT&T APIs must define at least one server
$
error
atandt-server-url-https
AT&T API servers must use HTTPS
$.servers[*]
warn
atandt-server-att-domain
AT&T API servers should use att.com domains
$.servers[*]
error
atandt-operation-id-required
All AT&T API operations must have an operationId
$.paths[*][get,post,put,patch,delete,options,head]
error
atandt-operation-summary-required
All AT&T API operations must have a summary
$.paths[*][get,post,put,patch,delete,options,head]
warn
atandt-operation-description-required
All AT&T API operations must have a description
$.paths[*][get,post,put,patch,delete,options,head]
warn
atandt-operation-tags-required
All AT&T API operations must have tags
$.paths[*][get,post,put,patch,delete,options,head]
warn
atandt-parameter-description-required
All AT&T API parameters must have a description
$.paths[*][*].parameters[*]
error
atandt-path-parameter-required
Path parameters must be marked as required
$.paths[*][*].parameters[?(@.in == 'path')]
error
atandt-request-body-content-required
AT&T API request bodies must define content
$.paths[*][*].requestBody
warn
atandt-request-body-json
AT&T API request bodies should support application/json
$.paths[*][*].requestBody.content
error
atandt-response-description-required
All AT&T API responses must have a description
$.paths[*][*].responses[*]
error
atandt-success-response-required
AT&T API operations must define at least one success response
$.paths[*][get,post,put,patch,delete]
warn
atandt-error-400-defined
AT&T POST/PUT/PATCH operations should define 400 response
$.paths[*][post,put,patch].responses
warn
atandt-error-401-defined
AT&T API operations should define 401 response
$.paths[*][get,post,put,patch,delete].responses
warn
atandt-schema-type-required
AT&T API component schemas must have a type
$.components.schemas[*]
warn
atandt-schema-description-required
AT&T API component schemas must have a description
$.components.schemas[*]
error
atandt-security-schemes-required
AT&T APIs must define security schemes
$.components
warn
atandt-security-oauth2
AT&T APIs should use OAuth 2.0
$.components.securitySchemes[*]
warn
atandt-phone-number-e164
AT&T CAMARA APIs must use E.164 format for phone numbers
$.components.schemas[*].properties.phoneNumber
warn
atandt-tags-defined
AT&T APIs must define top-level tags
$