Amazon Systems Manager · API Governance Rules

Amazon Systems Manager API Rules

Spectral linting rules defining API design standards and conventions for Amazon Systems Manager.

13 Rules error 4 warn 8 info 1
View Rules File View on GitHub

Rule Categories

info no operation operationid parameter schema security servers

Rules

error
info-title-required
Info title must be present.
$.info
warn
info-description-required
Info description must be present.
$.info
error
operation-summary-required
Every operation must have a summary.
$.paths[*][*]
warn
operation-summary-prefix
Operation summaries must start with 'Amazon Systems Manager'.
$.paths[*][*].summary
error
operation-operationId-required
Every operation must have an operationId.
$.paths[*][*]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][*]
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][*].parameters[*]
warn
security-schemes-defined
Security schemes must be defined.
$.components
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the amazonaws.com domain.
$.servers[*].url
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
info
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# amazon-systems-manager — 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 amazonaws.com
#   - operationid-casing: pascal @ 100% (n=7)
#   - schema-properties-casing: pascal @ 89% (n=9)
#   - merge: kept 8 existing, added 5 measured, upgraded 0
#   - added: servers-https-only, servers-expected-domain, operationid-casing, schema-properties-casing, no-empty-descriptions
extends:
  - spectral:oas
rules:
  info-title-required:
    description: Info title must be present.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-description-required:
    description: Info description must be present.
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  operation-summary-required:
    description: Every operation must have a summary.
    severity: error
    given: $.paths[*][*]
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries must start with 'Amazon Systems Manager'.
    severity: warn
    given: $.paths[*][*].summary
    then:
      function: pattern
      functionOptions:
        match: ^Amazon Systems Manager
  operation-operationId-required:
    description: Every operation must have an operationId.
    severity: error
    given: $.paths[*][*]
    then:
      field: operationId
      function: truthy
  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: $.paths[*][*]
    then:
      field: tags
      function: truthy
  parameter-description-required:
    description: Every parameter must have a description.
    severity: warn
    given: $.paths[*][*].parameters[*]
    then:
      field: description
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-expected-domain:
    description: Server URLs should be on the amazonaws.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: amazonaws\.com
  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-properties-casing:
    description: Schema properties should be PascalCase (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy