Skip to main content

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

Project description

Jentic API Tools - Pipelines

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

Key Features

The pipelines package provides two main workflow functions: import_openapi runs the full import pipeline (fetch, parse, validate, convert, bundle, repair, score, store) and score_openapi runs a lighter scoring pipeline (fetch, parse, bundle, validate, score). Both functions 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; this is controlled by reject_invalid_server_urls in OASProcessConfiguration. 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.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jentic_apitools_pipelines-1.0.0a8.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jentic_apitools_pipelines-1.0.0a8-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

Details for the file jentic_apitools_pipelines-1.0.0a8.tar.gz.

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a8.tar.gz
Algorithm Hash digest
SHA256 785e6d6e6795ae066c5681e3f3523a59d2605f70fa93fd09c49911e135fb33e0
MD5 7b88e0227808c007a6982d1f3c1dacbf
BLAKE2b-256 889ec48a4affd2b7376fc424f95a54ccf42e8a0a6e3af34afb37d663f426d78c

See more details on using hashes here.

File details

Details for the file jentic_apitools_pipelines-1.0.0a8-py3-none-any.whl.

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 3b608693ebffbd574facb1d36c6a9d314d68236a305ef6e561d526338296f988
MD5 883043dce15195eec1008533af4d0855
BLAKE2b-256 1bf0abda34cbac530942c84ece4d7fa70aec59f0621fff26ed6bdb127756b268

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page