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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tesserakit_openapi-0.4.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tesserakit_openapi-0.4.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file tesserakit_openapi-0.4.0.tar.gz.

File metadata

  • Download URL: tesserakit_openapi-0.4.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for tesserakit_openapi-0.4.0.tar.gz
Algorithm Hash digest
SHA256 39af4a7346c4b768fd795c487a378786495ab6148d0442897e209c47bceecd55
MD5 8f873a2ca6b5d7e802c12b400d80efc4
BLAKE2b-256 0da4a6df0a0f4304d397155f5bb0fe91a93aafdf481b7d408f0f5dcaddbe20a9

See more details on using hashes here.

File details

Details for the file tesserakit_openapi-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tesserakit_openapi-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ae8f011df6b697299a844052f742c6c483dcba80311c32d6699f53fd071aedb
MD5 ebf37cd1a4e03524d66b3f05cbcff984
BLAKE2b-256 bf69d4445a91f08efc01396673c9ed003458d5d50a1be71042ea237a26af691b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page