Azure Synapse Analytics · API Governance Rules
Azure Synapse Analytics API Rules
Spectral linting rules defining API design standards and conventions for Azure Synapse Analytics.
15 Rules
error 5
warn 6
info 4
Rule Categories
info
openapi
operation
parameter
paths
response
schema
security
servers
tags
Rules
warn
info-title-format
API title must start with "Azure Synapse Analytics"
$.info.title
warn
operation-summary-prefix
Operation summaries must start with "Azure Synapse Analytics"
$.paths[*][get,post,put,patch,delete].summary
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
All operations must have a description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths[*]~
warn
openapi-version
Must use OpenAPI 3.x or Swagger 2.x
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
error
response-success-required
Operations must define at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
parameter-description-required
All inline parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[?(!@.$ref)]
info
schema-properties-description
Top-level schema properties should have descriptions
$.components.schemas[*].properties[*]
info
tags-global-definition
All tags used in operations should be defined globally
$.tags
info
operation-id-camel-case
OperationIds should use consistent naming
$.paths[*][get,post,put,patch,delete].operationId
info
security-defined
Security schemes should be defined
$.components.securitySchemes