Amazon App Mesh · API Governance Rules

Amazon App Mesh API Rules

Spectral linting rules defining API design standards and conventions for Amazon App Mesh.

12 Rules error 3 warn 8 info 1
View Rules File View on GitHub

Rule Categories

amazon error no operationid path query schema security servers

Rules

error
amazon-app-mesh-info-title
API must have a title.
$.info
error
amazon-app-mesh-operation-summary
Operations must have summaries.
$.paths[*][get,post,put,patch,delete]
error
amazon-app-mesh-operation-id
Operations must have operationIds.
$.paths[*][get,post,put,patch,delete]
warn
servers-https-only
Server URLs must use HTTPS.
$.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 camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
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
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
error-schema-defined
A shared error schema (InternalServerErrorException) should be defined for error payloads.
$.components.schemas
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# amazon-app-mesh — 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: 50% of servers already https (warn)
#   - path-params-casing: camel @ 100% (n=122)
#   - query-params-casing: camel @ 84% (n=100)
#   - operationid-casing: pascal @ 100% (n=76)
#   - schema-names-casing: pascal @ 100% (n=666)
#   - schema-properties-casing: snake @ 54% (n=952)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: InternalServerErrorException
#   - pagination params observed: ['limit', 'nextToken']
#   - merge: kept 3 existing, added 9 measured, upgraded 0
#   - added: servers-https-only, path-params-casing, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, error-schema-defined, no-empty-descriptions
extends:
  - spectral:oas
rules:
  amazon-app-mesh-info-title:
    description: API must have a title.
    message: Info must include title.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  amazon-app-mesh-operation-summary:
    description: Operations must have summaries.
    message: Operation must include summary.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
  amazon-app-mesh-operation-id:
    description: Operations must have operationIds.
    message: Operation must include operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  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 camelCase (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: camel
  operationid-casing:
    description: Operation IDs should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: pascal
  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
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  error-schema-defined:
    description: A shared error schema (InternalServerErrorException) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: InternalServerErrorException
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy