Nimbus Schemas

This directory contains a package of schemas published to various repositories for use by different parts of the Mozilla Nimbus experimentation ecosystem.

Installation/Usage

Prerequisites

python ^3.10
poetry ^1.8.4
node ^16
yarn ^1.22

Common Operations

From project root (i.e., parent to this directory)

Build: make schemas_build
Run linting and tests: make schemas_check
Code formatting: make schemas_format

Adding New Schemas

Example Creating a new sub-package new_stuff

Add new directory mozilla_nimbus_schemas / new_stuff with schemas inside.
Add new_stuff schemas to the new_stuff directory's __init__.py file.
Add new_stuff to top level __init__.py:

from mozilla_nimbus_schemas.new_stuff import *
Generate Typescript and/or JSON Schemas for new_stuff by updating the generate_json_schema.py script like so:

a. Import new_stuff alongside existing mozilla_nimbus_schemas imports, e.g.,

from mozilla_nimbus_schemas import experiments, jetstream, new_stuff

b. (optional) Add new_stuff to Typescript generation
- Update TS_SCHEMA_PACKAGES list, e.g.,
  
  TS_SCHEMA_PACKAGES = [experiments, jetstream, new_stuff]
c. (optional) Add new_stuff to JSON Schema generation
- Update JSON_SCHEMA_PACKAGES list, e.g.,
  
  JSON_SCHEMA_PACKAGES = [experiments, new_stuff]
Build everything with make schemas_build
Update the version (see Versioning below).

Schemas

Jetstream

Contains schemas describing analysis results, metadata, and errors from Jetstream.

Experiments

Defines the schemas used for validating the Experimenter v6 API. Previously defined in the now-deprecated nimbus-shared.

Deployment

The build and deployment occurs automatically through CI. A deployment is triggered on merges into the main branch when the version number changes. Schemas are published to various repos for access in different languages.

Versioning

mozilla-nimbus-schemas uses semantic versioning (semver) of major.minor.patch. Previously, we used a date-based versioning scheme (CalVer), which is why the version is so high (3000+). Any breaking changes should result in an increase in the major version.

Version Updates

To update the published package versions, update the VERSION file in this directory.

From the project root, you can run the helper script:
- ./scripts/set_schemas_version.sh <version>
Or write to the file:
- echo <version> > ./schemas/VERSION
Or simply edit the file in any text editor.

Update the package versions with the new VERSION file:

make schemas_version

Python

Published to PyPI as mozilla-nimbus-schemas

Typescript

Published to NPM as @mozilla/nimbus-schemas

Rust

Not yet implemented.

Release files for mozilla-nimbus-schemas 3005.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mozilla-nimbus-schemas 3005.1.0
File	Size	Uploaded
mozilla_nimbus_schemas-3005.1.0.tar.gz	37.4 kB	Sep 24, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for mozilla-nimbus-schemas 3005.1.0
File	Interpreter	ABI	Platform	Reset
mozilla_nimbus_schemas-3005.1.0-py3-none-any.whl 82.5 kB Sep 24, 2026	Python 3	none	any	Details

Total release size: 119.9 kB

Release files / mozilla_nimbus_schemas-3005.1.0.tar.gz

Download URL	mozilla_nimbus_schemas-3005.1.0.tar.gz
Size	37.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`1706892665917499bbd60804c8d30df2d24a43a4fc0be38d92cfa293e1ac15a5`
BLAKE2b-256 checksum How to use checksums	`169c5cbe945ec19c10329bbd8df0bdc0f40fd256d39f824b3b59b1be41554905`
Upload date	Sep 24, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/mozilla/experimenter
Publishing commit: github.com/mozilla/experimenter/tree/44b14a9c163522f8e1b1ce0afba11902dbeba11a

Workflow

Publishing configuration: github.com/mozilla/experimenter/blob/44b14a9c163522f8e1b1ce0afba11902dbeba11a/.github/workflows/deploy-schemas.yml
Publishing logs: github.com/mozilla/experimenter/actions/runs/36023771990/attempts/1

Artifact

Subject: mozilla_nimbus_schemas-3005.1.0.tar.gz
SHA-256 checksum: 1706892665917499bbd60804c8d30df2d24a43a4fc0be38d92cfa293e1ac15a5 Verifying attestations

Release files / mozilla_nimbus_schemas-3005.1.0-py3-none-any.whl

Download URL	mozilla_nimbus_schemas-3005.1.0-py3-none-any.whl
Size	82.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5a5ab741c1cacd1e73fb3046d89d983b7529346dd2522e1ccd165431f516aa29`
BLAKE2b-256 checksum How to use checksums	`b3052e93236b76ee28d17ba68a52b626dc6b4102a55c34824cdb18891111f2db`
Upload date	Sep 24, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/mozilla/experimenter
Publishing commit: github.com/mozilla/experimenter/tree/44b14a9c163522f8e1b1ce0afba11902dbeba11a

Workflow

Publishing configuration: github.com/mozilla/experimenter/blob/44b14a9c163522f8e1b1ce0afba11902dbeba11a/.github/workflows/deploy-schemas.yml
Publishing logs: github.com/mozilla/experimenter/actions/runs/36023771990/attempts/1

Artifact

Subject: mozilla_nimbus_schemas-3005.1.0-py3-none-any.whl
SHA-256 checksum: 5a5ab741c1cacd1e73fb3046d89d983b7529346dd2522e1ccd165431f516aa29 Verifying attestations