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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.13.tar.gz
Algorithm Hash digest
SHA256 adbe57d2ed2f8b7be5d1e2ed7dbbbefda5e39e4c4c8028aaff13fb5fdd01f443
MD5 92aff7b3d4a9bab897c703ac1956ce53
BLAKE2b-256 f629ba9c93d6e395d779ebc9b015b91269af1a8f09ba37b7bbdae89953bfeef4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 04bb1284235413602a0e5657327c5ee1523dac77b4f62d5ad13fb0442e181877
MD5 ffa13ffb00c74078dad5d392be262723
BLAKE2b-256 2ddf98daef60eb40497774f57812625fbe3f4cf386b35508101741cb11709ba7

See more details on using hashes here.

Provenance

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