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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.12.tar.gz
Algorithm Hash digest
SHA256 a3f9a8d86006a236714728e973a197b54f2847806b1533366abbf87792570c4f
MD5 9ba2dee06c311780cbc3f1faeaf97607
BLAKE2b-256 8dfce17a7066b83bc2807b448b7075ff8e32c48d6c80140a48dc8a8a25b6965e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for openlatch_client_schemas-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 be4ede1d28199dacb7658744feae808777ff51d1a5dab0788110fe09013fe816
MD5 d7cae122824cd8247ad2e190f29e30ee
BLAKE2b-256 b4644eb53486358d2154e32494f7c0bc0d222cc6c2d2538b3c110ecfdf275ac1

See more details on using hashes here.

Provenance

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