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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a7.tar.gz
Algorithm Hash digest
SHA256 948de62b184b5ad4d71e237852c7d3a0bb8ca93de4c9f23b3441d69b469c3cc9
MD5 03b6782e50661f21e352c01f313cc962
BLAKE2b-256 6dc63d699f07a2996827d26f5c4a47d74afd75b4f120d81a64af2735be4ee0cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a7-py3-none-any.whl
Algorithm Hash digest
SHA256 edbed49c4ab13a419b61ec2dcb954fdaf868e62947de3f0e7adc0dbf895903b8
MD5 4b90cf4472af655615fce703cf97ce48
BLAKE2b-256 a04e893c2ff586cda0fa514a5df19ea796ee8ad18e4c8bfb6ce608c23923f082

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