Overview

Reference

Lookup material for the .well format, generated from the schema and the spec: objects and fields, the JSON Schema, vocabularies and example files.

These pages are for looking things up. The object reference and the JSON Schema are generated from the reference implementation, so they always match it. The meaning of each field, and the rules around it, are in the specification, and every object page links to its section there.

Object reference

Every block and object of a .well file, with its fields, types, constraints and spec section.

JSON Schema

The published schema, how it is generated and how to validate with it in any language.

Example wells

Nineteen complete files with live previews, for learning and testing.

FGDC textures

All 282 lithology pattern codes used by texture.

Vocabularies

The recommended and allowed values of each field are listed in the specification:

Recommended vocabularies: construction methods, uses, materials, event types, log categories, permit types and more.
Water quality recommended values and the parameter vocabulary.
Texture vocabularies for lithology patterns.

The same lists, with English and Portuguese labels, are exported by @welldot/core as data (Vocabularies and textures). Vocabularies explains open and closed lists.

Units

Every field's unit is in the spec's field-to-unit binding. Units and precision summarizes it.

Building an editor or database on .well

JSON Schema