Teradata · API Governance Rules
Teradata API Rules
Spectral linting rules defining API design standards and conventions for Teradata.
30 Rules
error 13
warn 13
info 4
Rule Categories
delete
examples
get
info
no
openapi
operation
parameter
paths
post
response
schema
security
servers
Rules
error
info-title-required
Info title must be present.
$.info
warn
info-title-prefix
Info title should start with Teradata.
$.info.title
error
info-description-required
Info description must be present.
$.info
error
info-version-required
Info version must be present.
$.info
warn
info-contact-required
Contact information should be provided.
$.info
warn
openapi-version
OpenAPI version should be 3.0.x.
$
error
servers-defined
Servers array must be defined.
$
warn
servers-https
Server URLs should use HTTPS.
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case.
$.paths
error
paths-no-trailing-slash
Paths should not have trailing slashes.
$.paths
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with Teradata.
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have tags.
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camelcase
OperationId should be camelCase.
$.paths[*][get,post,put,patch,delete].operationId
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-camelcase
Parameter names should use camelCase.
$.paths[*][get,post,put,patch,delete].parameters[*].name
error
response-success-required
Operations must have a success response (2xx).
$.paths[*][get,post,put,patch,delete].responses
warn
response-description-required
Every response must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-properties-camelcase
Schema property names should use camelCase.
$.components.schemas[*].properties
warn
schema-description-required
Top-level schemas should have descriptions.
$.components.schemas[*]
error
schema-type-required
Schemas must have a type defined.
$.components.schemas[*]
error
security-defined
Global security must be defined.
$
error
security-schemes-defined
Security schemes must be defined in components.
$.components
error
get-no-request-body
GET operations should not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
info
post-request-body-required
POST operations should have a request body.
$.paths[*].post
error
no-empty-descriptions
Descriptions must not be empty strings.
$..description
info
examples-encouraged
Schema properties should include example values.
$.components.schemas[*].properties[*]