jentic-apitools-pipelines 1.0.0a20

Jentic Apitools Pipelines - Orchestrate score, repair, and storage into workflow pipelines

Jentic API Tools - Pipelines

High-level workflows that orchestrate analyze, score, repair, and storage operations for OpenAPI specifications.

Key Features

The pipelines package provides three main workflow functions: import_openapi runs the full import pipeline (fetch, parse, validate, convert, bundle, repair, score, store), score_openapi runs a lighter scoring pipeline (fetch, parse, bundle, validate, score), and improve_openapi orchestrates the apply-overlays-and/or-replace-spec, score, and lay-out-per-run-snapshot flow used behind /public-apis/improve and the jentic-apitools improve CLI command. The first two accept an OASJsonRequest with processing configuration and an optional progress callback for real-time updates. By default, import_openapi rejects specs with invalid server URLs and invalid security definitions; these are controlled by reject_invalid_server_urls and reject_invalid_security in OASProcessConfiguration. The improve orchestrator depends on the repair.overlay backend to apply overlays and to verify the cumulative-overlays invariant, raising CumulativeInvariantError (with a structured diff) when applying cumulative + per_run overlays to the immutable bundled input does not reproduce the produced spec. The package handles format conversion from Swagger 2.0 and Google Discovery to OpenAPI 3.x, reference bundling via Redocly, and artifact management through configurable storage contexts. The repo_tools module provides rebuild_scores_json and rebuild_apis_json for rebuilding the root scores.json and apis.json catalog files from all API specs in a local repository clone.

Dependencies

Internal: common, llm, analyze, score, repair, storage. External: jentic-openapi-transformer (with redocly), datadog. Note: repair is a hard dependency (used by both the import flow and the new improve orchestrator).

Installation

pip install jentic-apitools-pipelines

Quick Start

from jentic.apitools.common.models import OASJsonRequest, OASRequestMeta, OASProcessConfiguration
from jentic.apitools.pipelines import score_openapi

request = OASJsonRequest(meta=OASRequestMeta(oas_process_configuration=OASProcessConfiguration()))
result = score_openapi(request, spec_url="https://petstore3.swagger.io/api/v3/openapi.json")
print(f"Success: {result.success}")

Testing

pytest tests -v