Azure Container Apps · API Governance Rules
Azure Container Apps API Rules
Spectral linting rules defining API design standards and conventions for Azure Container Apps.
17 Rules
error 7
warn 8
info 2
Rule Categories
info
openapi
operation
parameter
paths
response
schema
security
servers
tags
Rules
warn
info-title-format
API title must start with "Azure Container Apps"
$.info.title
warn
operation-summary-prefix
Operation summaries must start with "Azure Container Apps"
$.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]
warn
paths-kebab-case
Path segments must use kebab-case
$.paths[*]~
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths[*]~
error
openapi-version
Must use OpenAPI 3.x
$.openapi
error
servers-defined
Servers must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
warn
security-defined
Security schemes must be defined
$.components.securitySchemes
error
response-success-required
Operations must define at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
schema-type-required
All schemas must define a type
$.components.schemas[*]
info
tags-title-case
Global tag names should use Title Case
$.tags[*].name
info
operation-id-camel-case
OperationIds should use PascalCase with underscore separator
$.paths[*][get,post,put,patch,delete].operationId