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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a11.tar.gz
Algorithm Hash digest
SHA256 b3747b2c9921a7091e2511762db27e2daead3d43d04c064a0dd6f6751e445fc7
MD5 9db180e3da98fc73409553d81b7d8bc5
BLAKE2b-256 c91f1a974f8e0e74f305c297236a483b82decd07d6deb9eff96392d67ff4b47e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a11-py3-none-any.whl
Algorithm Hash digest
SHA256 e38b2a32bc2a7495751a2613e0040dbac1181d7d37f564f15aab38310880ac61
MD5 5dd9ed3b7acb9c98c30e0366f3102a28
BLAKE2b-256 e00f5b8d4e676eb072c1435110991994add83a0d94463a7463c8e43d74ddc427

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