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. 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.0a4.tar.gz (27.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.0a4-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a4.tar.gz
Algorithm Hash digest
SHA256 ce0c1c7a5282baa17cb95998c53898208e00aac98c448dedf120d5d34fba4f39
MD5 4274ca4193ac4ebae939fb987a253c84
BLAKE2b-256 b9b24337881b021c88e69645812aa14dbf55fb7e682463981f15885f97772800

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 a9273a46c0720adfb4dee102f41e54e67e67260d9e277278a7d094135a6eafc8
MD5 29ddc0f0d97cf671a0645325fe328292
BLAKE2b-256 6c5cc443f422c404785e7ca4ba086107f36ff4b7852f9ad3a2ea15153f84722a

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