Amdocs · API Governance Rules
Amdocs API Rules
Spectral linting rules defining API design standards and conventions for Amdocs.
21 Rules
error 12
warn 7
info 2
Rule Categories
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
Rules
warn
info-title-prefix
API title must start with "Amdocs"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
openapi-version-3
Use OpenAPI 3.x
$.openapi
error
servers-defined
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[*]~
info
paths-versioned
Paths should include API version prefix
$.paths[*]~
error
operation-summary-required
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-description-required
Operations must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
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
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Parameters must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Operations must have a success response
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-required
Operations should define 401 Unauthorized
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Response objects must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-required
Component schemas should have a description
$.components.schemas[*]
info
security-oauth2
APIs should use OAuth 2.0 security scheme
$.components.securitySchemes[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty
$..description