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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.14.tar.gz
Algorithm Hash digest
SHA256 edb10576e316a61bd0c8ad572a080e102de90e29ac66ffafab5c3fe537ff6441
MD5 3edce1238b0467a65a66bc84fb469135
BLAKE2b-256 72bf24ad455a800f602ed78faa266adbde0d9cce60472f3b74bb3dd05a2f286d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 865f2d460e289ddf7f396a396ff1d17a96593424a719b6c909112039f01451aa
MD5 8cd64862210bd60b0aa90d79a329b7d4
BLAKE2b-256 3b7dbd429f27b41bd771588aff9277d701a58b2533c58e6c96d75e8f78347df8

See more details on using hashes here.

Provenance

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