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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a10.tar.gz
Algorithm Hash digest
SHA256 b70234a2cc1dd71dd4a3fa3777a48ec4a0d642449814a24bdd6e09b78db9b47a
MD5 a9dd3a4d2135e66defac3442f4b9c513
BLAKE2b-256 69647a3361067fba449bde24db1d5cea49026515ece42154725a4e7a797572c7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a10-py3-none-any.whl
Algorithm Hash digest
SHA256 ceb93718188fa283322f6b448d83791bc334eba19535f710651f951fed5b9e0e
MD5 321df17d392343eb30e3f0584d711608
BLAKE2b-256 3e404f047d55ad7a859789365b76a2120323b4227d86b53122f459c0d4a298a9

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