Skip to main content

OpenLatch client wire-format JSON Schemas — canonical contract for events exchanged between openlatch-client and openlatch-platform

Project description

openlatch-client-schemas

Canonical JSON Schemas for the openlatch-client wire format. This package is the source of truth for the contract between openlatch-client (Rust) and openlatch-platform (Python + React).

Usage

from openlatch_client_schemas import schemas_path, load, load_all

schemas_path()                 # pathlib.Path to the bundled schemas/ directory
load_all()                     # {"enums": {...}, "event-envelope": {...}, ...}
load("event-envelope")         # parsed schema for one file

Contents

File Purpose
enums.schema.json AgentType, HookEventType, Verdict
event-envelope.schema.json EventEnvelope wire-format
verdict-response.schema.json VerdictResponse returned to agent hooks
cloud-ingestion-request.schema.json CloudIngestionRequest sent to platform
cloud-ingestion-response.schema.json CloudIngestionResponse from platform
auth-me-response.schema.json AuthMeResponse for /api/v1/users/me

Version is synchronized with the openlatch-client crate — every published version corresponds to the binary release of the same version.

Breaking Changes

Breaking schema changes require a major version bump. Consumers pinning an exact version will not be silently broken. See the openlatch-client CHANGELOG for what changed.

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

openlatch_client_schemas-0.1.8.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

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

openlatch_client_schemas-0.1.8-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file openlatch_client_schemas-0.1.8.tar.gz.

File metadata

  • Download URL: openlatch_client_schemas-0.1.8.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openlatch_client_schemas-0.1.8.tar.gz
Algorithm Hash digest
SHA256 13a2d12b941c0d73164961fd30dcd7027132cd161c54a6930ddc0e5cadfe89c4
MD5 cf14b1428a56008187d9a75f8e8083fb
BLAKE2b-256 01e090cd9b8e51845c1db8e3faceaf97bd7e7df07c93da5a1bf546aa00d523a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for openlatch_client_schemas-0.1.8.tar.gz:

Publisher: publish.yml on OpenLatch/openlatch-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openlatch_client_schemas-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 955913ce10f9c12e49ff047df98234fc03d52cf67f604a773436dd42fa1fc737
MD5 e99e94cae1e2f2c21718ab8672539ce1
BLAKE2b-256 f173e9c6a6792603ba807671e7d3f43482c8f93c8b0518ea0431dd8c02a67b75

See more details on using hashes here.

Provenance

The following attestation bundles were made for openlatch_client_schemas-0.1.8-py3-none-any.whl:

Publisher: publish.yml on OpenLatch/openlatch-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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