Skip to main content

Maturity Levels

Maturity reports progressive API quality independently of the overall pass/fail summary.

Non compliant → Baseline → Bronze → Silver → Gold → Platinum

How maturity is calculated​

  • Only enabled rules with severity: error participate.
  • Every participating rule has a required maturity level.
  • The first maturity level containing a failed rule becomes the blocking level.
  • Reported maturity is the level immediately below that blocking level.
  • When no participating rule fails, Specmatic reports the highest configured level.

Example: if all Baseline and Bronze rules pass but a Silver rule fails, reported maturity is Bronze.

Warnings remain in reports but do not reduce maturity.

Assign maturity to rules​

Override maturity for a built-in rule:

profiles:
  default:
    rules:
      extends:
        - recommended
      override:
        operation-summary:
          severity: error
          maturity: bronze
        info-license:
          severity: error
          maturity: gold

Or assign it to a custom rule:

rules:
  company/parameter-description:
    type: parameters
    severity: error
    maturity: silver
    on:
      type: Parameter
    must:
      required:
        - description

Custom enabled rules without an explicit maturity default to Baseline.

Use maturity for adoption​

Set a reachable target, fix rules at that level, then move upward. Keep blocking behavior controlled by severity: use warn while introducing a rule, then promote it to error when teams are ready.