Integrate a tool

You do not need the Python packages to speak UMP. The contract is the specification plus its published JSON Schemas, and any language with a JSON Schema 2020-12 validator can check a document against it.

Informative

These pages are guides. The specification and the published schemas are normative; where a guide and the spec disagree, the spec wins.

Start here

• Quickstart: fetch two schemas, write a document from the section 5 example, and validate it. About ten minutes, no checkout needed.
• Conformance classes: one short how-to per class in section 2, saying what your tool has to do and which section to read next.

What is not published yet

• The OpenAPI document. The HTTP API of section 19 has no published OpenAPI file yet, so these pages show no request and response pairs. They will be added from that document once it exists.
• The conformance suite. Section 21 describes it; it is not yet released. Until it is, a tool can validate shapes against the schemas but cannot claim a class.
• The schema host. Each schema’s $id (for example https://schemas.ump.dev/v1/estimand.json) is an identifier, not a download address. The files are mirrored on this site under /schemas/v1/. Where the identifiers will resolve is an open question in section 24.