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.4.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.4-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openlatch_client_schemas-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 91cb54060627d3d7656fb131d207100ecce93d9be196d3fb7fc9349486b3b32f
MD5 b8c328146e738e541ff969e916802ada
BLAKE2b-256 377261744ef996badb5ece4a7963ea44f8bf402ca18473fa9ca76c0bbaf8de2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for openlatch_client_schemas-0.1.4.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.4-py3-none-any.whl.

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8b56596a876f41154f5f921dc0da72114c954d77725ff7ff197830d3b1943964
MD5 18f659191b1e687cb99b2374871da4ab
BLAKE2b-256 f9edc889d68360cde590b3bae7d11113e4b06902a9c09c59f01178c9375536b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for openlatch_client_schemas-0.1.4-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