OpenAPI Example Runner

Load a public or supplied OpenAPI document, execute bounded safe operations, and report documented-response, failure, or safe-skip outcomes.

Inputs

• openapiSpecUrl: Public JSON OpenAPI document URL.
• openapiSpecJson: Optional inline OpenAPI document.
• baseUrl: Base URL used to construct request URLs.
• pathAllowlist: Paths eligible for bounded checks.
• requestOverrides: Optional URLs or headers keyed by operation ID.
• timeoutMs: OpenAPI document and safe-request timeout.
• maxExamples: Maximum paid operation rows to emit.
• skipUnsafeMethods: Skip state-changing methods by default.
• includeReport: Create Markdown and JSON report artifacts.
• maxChargeUsd: Stop before the next PPE event would exceed the run budget.

{
  "openapiSpecUrl": "https://httpbin.org/spec.json",
  "baseUrl": "https://httpbin.org",
  "pathAllowlist": ["/get"],
  "requestOverrides": {},
  "maxExamples": 1,
  "skipUnsafeMethods": true,
  "timeoutMs": 15000,
  "includeReport": true,
  "maxChargeUsd": 1
}

Dataset

Rows include operation ID, method, path, operation label, request URL, status, pass state, response time, schema-valid state, skip reason, error, warnings, and recommendation. Path-level OpenAPI metadata such as parameters is not misclassified as an operation.

Billing

The pay-per-event billing events are actor-start, schema-validated, contract-rule-checked, and report-generated. Dataset and report output is charge-gated. A zero-dollar cap emits no paid output.

Use Cases

• Check documented GET outcomes before API release.
• List unsafe operations skipped by the default policy.
• Detect live 4xx/5xx outcomes for safe requests.
• Create bounded operation result rows from an OpenAPI document.
• Export API example QA evidence with a report.

Limitations

The actor fetches a public JSON OpenAPI document when openapiSpecUrl is used and sends only GET, HEAD, or OPTIONS requests. State-changing methods remain skipped by default. Pass/fail checks confirm the live status is both successful and documented by the operation; full response-body JSON Schema validation is not performed.