Skip to main content

Navigator cross-service wire contract: tier/bucket/header/cookie constants and introspect/quota models

Project description

navigator-contracts

The Navigator cross-service wire contract: every name and shape that the OSINT service (auth authority), the Data service (thin auth client), and the published navigator-cli must agree on.

Constants and Pydantic models only — no logic. Validation, quota accounting, and hashing live in the OSINT service.

Compatibility obligation

Three consumers, two deployment models:

  1. The OSINT and Data services deploy together from the monorepo.
  2. Released navigator-cli versions are installed on member machines and cannot be redeployed. Server changes to /auth/cli/*, /api/tools/*, and PAT semantics must stay additive/compatible with every released CLI version. Removing or renaming anything here is a breaking release.

Models tolerate unknown extra fields by design (forward compatibility for installed CLIs talking to a newer authority).

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

navigator_contracts-0.1.1.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

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

navigator_contracts-0.1.1-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

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