Azure Container Apps API Rules
Spectral linting rules defining API design standards and conventions for Azure Container Apps.
23 Rules
error 7
warn 13
info 3
Rule Categories
info
no
openapi
operation
parameter
path
paths
query
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
warn
servers-expected-domain
Server URLs should be on the azure.com domain.
$.servers[*].url
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be kebab-case (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description
Spectral Ruleset
# azure-container-apps — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
# - servers-https-only: 100% of servers already https (error)
# - servers-expected-domain: 1/1 servers on azure.com
# - path-params-casing: camel @ 100% (n=65)
# - query-params-casing: kebab @ 96% (n=23)
# - schema-names-casing: pascal @ 100% (n=16)
# - schema-properties-casing: snake @ 81% (n=68)
# - security: global (root) — NOT emitting operation-security-required
# - merge: kept 17 existing, added 6 measured, upgraded 0
# - added: servers-expected-domain, path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, no-empty-descriptions
extends:
- spectral:oas
rules:
info-title-format:
description: API title must start with "Azure Container Apps"
severity: warn
given: $.info.title
then:
function: pattern
functionOptions:
match: ^Azure Container Apps
operation-summary-prefix:
description: Operation summaries must start with "Azure Container Apps"
severity: warn
given: $.paths[*][get,post,put,patch,delete].summary
then:
function: pattern
functionOptions:
match: ^Azure Container Apps
operation-id-required:
description: All operations must have an operationId
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: operationId
function: truthy
operation-summary-required:
description: All operations must have a summary
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: summary
function: truthy
operation-description-required:
description: All operations must have a description
severity: warn
given: $.paths[*][get,post,put,patch,delete]
then:
field: description
function: truthy
operation-tags-required:
description: All operations must have at least one tag
severity: warn
given: $.paths[*][get,post,put,patch,delete]
then:
field: tags
function: truthy
paths-kebab-case:
description: Path segments must use kebab-case
severity: warn
given: $.paths[*]~
then:
function: pattern
functionOptions:
match: ^(/[a-z0-9{}-]+)+$
paths-no-trailing-slash:
description: Paths must not end with a trailing slash
severity: error
given: $.paths[*]~
then:
function: pattern
functionOptions:
notMatch: /$
openapi-version:
description: Must use OpenAPI 3.x
severity: error
given: $.openapi
then:
function: pattern
functionOptions:
match: ^3\.
servers-defined:
description: Servers must be defined
severity: error
given: $
then:
field: servers
function: truthy
servers-https:
description: All server URLs must use HTTPS
severity: error
given: $.servers[*].url
then:
function: pattern
functionOptions:
match: ^https://
security-defined:
description: Security schemes must be defined
severity: warn
given: $.components.securitySchemes
then:
function: truthy
response-success-required:
description: Operations must define at least one 2xx response
severity: error
given: $.paths[*][get,post,put,patch,delete].responses
then:
function: schema
functionOptions:
schema:
anyOf:
- required:
- '200'
- required:
- '201'
- required:
- '202'
- required:
- '204'
parameter-description-required:
description: All parameters must have descriptions
severity: warn
given: $.paths[*][get,post,put,patch,delete].parameters[*]
then:
field: description
function: truthy
schema-type-required:
description: All schemas must define a type
severity: warn
given: $.components.schemas[*]
then:
field: type
function: truthy
tags-title-case:
description: Global tag names should use Title Case
severity: info
given: $.tags[*].name
then:
function: pattern
functionOptions:
match: ^[A-Z]
operation-id-camel-case:
description: OperationIds should use PascalCase with underscore separator
severity: info
given: $.paths[*][get,post,put,patch,delete].operationId
then:
function: pattern
functionOptions:
match: ^[A-Z][a-zA-Z]+_[A-Z][a-zA-Z]+$
servers-expected-domain:
description: Server URLs should be on the azure.com domain.
severity: warn
given: $.servers[*].url
then:
function: pattern
functionOptions:
match: azure\.com
path-params-casing:
description: Path parameters should be camelCase (the dominant convention in this API).
severity: warn
given: $.paths[*].parameters[?(@.in=='path')].name
then:
function: casing
functionOptions:
type: camel
query-params-casing:
description: Query parameters should be kebab-case (the dominant convention in this API).
severity: warn
given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
then:
field: name
function: casing
functionOptions:
type: kebab
schema-names-casing:
description: Component schema names should be PascalCase (the dominant convention in this API).
severity: warn
given: $.components.schemas
then:
field: '@key'
function: casing
functionOptions:
type: pascal
schema-properties-casing:
description: Schema properties should be snake_case (the dominant convention in this API).
severity: info
given: $.components.schemas[*].properties
then:
field: '@key'
function: casing
functionOptions:
type: snake
no-empty-descriptions:
description: Descriptions must not be empty strings.
severity: warn
given: $..description
then:
function: truthy