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 and invalid security definitions; these are controlled by reject_invalid_server_urls and reject_invalid_security 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.0a13.tar.gz (28.4 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.0a13-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a13.tar.gz
Algorithm Hash digest
SHA256 160aaead71bbae928e23b78200deb8be0ec312ff5f12bae993049328ec887857
MD5 86228e3a691ec8ba7bd9cb2489e7f3ce
BLAKE2b-256 88de45e770d6f5615f4e4e99b21680201718d05c9fb9b3d714570d39c9532716

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a13-py3-none-any.whl
Algorithm Hash digest
SHA256 4f712de8b15fc913c22b099ca830e80470a007d25e83654e1bcc0b366bdd997f
MD5 75812588118bfd35a8893b3632ba6010
BLAKE2b-256 abac1b6351297a5b52f34114c9cda0796e9d8248680bec0273f7fb719fe4280b

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