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.0a5.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.0a5-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a5.tar.gz
Algorithm Hash digest
SHA256 30f7e434d24efc53ca961ab97ad9b1ccd8cdcaebecc92d262594e1066903632f
MD5 54c284f96b987df8f77182dab2130b0a
BLAKE2b-256 fa7697f1f9b54948f8bc177eedee18779008fd315f42113ab2dc55d532f8b345

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 66187852daec206135213703adfc5e2f0412adb72f694b1a27c320d824a20372
MD5 f1d4488f7231f8132ab1e5c2a6a8764d
BLAKE2b-256 130d0d35d50be4527cc48ead7875851484bd2841b8ec4ddf19f33b21bda190ff

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