AWS Step Functions API Rules

# aws-step-functions — 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)
#   - query-params-casing: camel @ 100% (n=10)
#   - operationid-casing: pascal @ 100% (n=26)
#   - schema-names-casing: pascal @ 99% (n=173)
#   - schema-properties-casing: camel @ 60% (n=319)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: SensitiveError
#   - pagination params observed: ['maxResults', 'nextToken']
#   - merge: kept 8 existing, added 8 measured, upgraded 0
#   - added: servers-https-only, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, error-schema-defined, no-empty-descriptions
extends:
  - spectral:oas
rules:
  sfn-operation-summary:
    description: All operations must have a summary starting with "AWS Step Functions"
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: summary
      function: pattern
      functionOptions:
        match: ^AWS Step Functions
  sfn-operation-id:
    description: All operations must have an operationId
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  sfn-info-title:
    description: Info object must have a title
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  sfn-info-version:
    description: Info object must have a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  sfn-response-description:
    description: All responses must have a description
    severity: error
    given: $.paths[*][*].responses[*]
    then:
      field: description
      function: truthy
  sfn-microcks-annotation:
    description: Operations should have x-microcks-operation annotation
    severity: info
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: x-microcks-operation
      function: truthy
  sfn-schema-type:
    description: Schema components should have a type
    severity: warn
    given: $.components.schemas[*]
    then:
      field: type
      function: truthy
  sfn-security-defined:
    description: API security schemes should be defined
    severity: warn
    given: $
    then:
      field: components.securitySchemes
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  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 camelCase (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]*$
  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 (SensitiveError) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: SensitiveError
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy