ADT · API Governance Rules
ADT API Rules
Spectral linting rules defining API design standards and conventions for ADT.
31 Rules
error 16
warn 11
info 4
Rule Categories
delete
examples
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
Rules
warn
info-title-adt-prefix
API title must start with "ADT"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must declare a version
$.info
warn
info-contact-required
API should include contact information
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
servers-defined
API must define servers
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
servers-description
Servers should have descriptions
$.servers[*]
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
info
paths-lowercase-kebab
Path segments should use lowercase and hyphens
$.paths[*]~
error
operation-summary-required
Operations must have summaries
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-adt-prefix
Summaries should start with "ADT"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Operations must have descriptions
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Operations must have operationIds
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camelcase
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Operations must have tags
$.paths[*][get,post,put,patch,delete]
error
parameter-description-required
Parameters must have descriptions
$.paths[*][*].parameters[*]
error
parameter-schema-required
Parameters must have schemas
$.paths[*][*].parameters[*]
warn
request-body-description
Request bodies should have descriptions
$.paths[*][post,put,patch].requestBody
error
response-success-required
Operations must define 2xx responses
$.paths[*][get,post,put,patch,delete]
warn
response-401-defined
Operations should define 401 Unauthorized response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Responses must have descriptions
$.paths[*][*].responses[*]
warn
schema-description
Component schemas should have descriptions
$.components.schemas[*]
warn
schema-type-defined
Schemas should define a type
$.components.schemas[*]
info
schema-properties-camelcase
Schema property names should use camelCase
$.components.schemas[*].properties[*]~
error
security-schemes-defined
API must define security schemes
$.components
warn
security-global-defined
API should define global security
$
error
get-no-request-body
GET operations must not have request bodies
$.paths[*].get
info
delete-returns-204
DELETE operations should return 204 No Content
$.paths[*].delete.responses
error
no-empty-descriptions
Descriptions must not be empty
$..description
info
examples-encouraged
Responses should include examples
$.paths[*][get,post,put,patch,delete].responses[*].content[*]