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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a15.tar.gz
Algorithm Hash digest
SHA256 5c96b1f17d236d47e2bc6de75764cb3b16bb662559182fe0eac30a0e26ab3f0b
MD5 d8fdd38cf090fe64eaaf634df48a5be6
BLAKE2b-256 c33124b4158c452913fd329eed226bbf5dcb82e430e070a3cfc217de27a63772

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jentic_apitools_pipelines-1.0.0a15-py3-none-any.whl
Algorithm Hash digest
SHA256 c7c63ab70f6438fe0b8636addaec7cf32fa7e1976eba09c4fc9b4e4531f61257
MD5 1c1a16d07b0072bcf49ab929894fb828
BLAKE2b-256 dc54fabd9d77ed3b5759cdc7ace209b5b02a251cb0d573d0106c915c996fdd65

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