Skip to main content

tesserakit-openapi

Lint an OpenAPI/Swagger spec into a validated endpoint catalog.

tessera-openapi parses an OpenAPI 3.x or Swagger 2.0 document, builds a canonical Endpoint catalog, and lints for common spec-hygiene problems. It reads the spec only: nothing is fetched and no requests are made. It pairs naturally with tessera-api (curl traces in, spec quality out).

Input

A spec file (.json / .yaml / .yml) or a directory containing one (it looks for openapi.* / swagger.*, then any yaml/json that mentions openapi/swagger).

Lint a spec

tessera openapi lint --input examples/openapi/petstore.yaml --output ./out/openapi_pack

Artifacts written:

endpoints.jsonl          one Endpoint per operation (method, path, params, responses, ...)
index.md                 endpoint catalog table
validation_report.md     lint findings
coverage_report.md       operationId / summary / security coverage, method distribution
surface.md               the API surface grouped by tag

Lint rules

  • invalid_spec — not parseable / not an OpenAPI document
  • no_endpoints — the spec declares no operations
  • duplicate_operation_id — two operations share an operationId
  • missing_operation_id — an operation has no operationId
  • path_param_not_declared — {param} in the path is not declared in parameters
  • declared_param_not_in_path — a path parameter is declared but absent from the path template
  • missing_2xx_response — no success (2xx/default) response is defined
  • missing_summary, no_tags, no_security, deprecated_endpoint (informational)

Both OpenAPI 3.x (requestBody, servers) and Swagger 2.0 (in: body params, host) are handled.

Metadata

Release files for tesserakit-openapi 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tesserakit-openapi 0.4.0
File Size Uploaded
tesserakit_openapi-0.4.0.tar.gz 7.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tesserakit-openapi 0.4.0
File Interpreter ABI Platform
tesserakit_openapi-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 16.9 kB

Release files / tesserakit_openapi-0.4.0.tar.gz

Download URL tesserakit_openapi-0.4.0.tar.gz
Size 7.3 kB
Tags Source
SHA-256 checksum
How to use checksums
39af4a7346c4b768fd795c487a378786495ab6148d0442897e209c47bceecd55
BLAKE2b-256 checksum
How to use checksums
0da4a6df0a0f4304d397155f5bb0fe91a93aafdf481b7d408f0f5dcaddbe20a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release files / tesserakit_openapi-0.4.0-py3-none-any.whl

Download URL tesserakit_openapi-0.4.0-py3-none-any.whl
Size 9.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ae8f011df6b697299a844052f742c6c483dcba80311c32d6699f53fd071aedb
BLAKE2b-256 checksum
How to use checksums
bf69d4445a91f08efc01396673c9ed003458d5d50a1be71042ea237a26af691b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.11

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page