Standardised Field / Constant / Variable Names¶
Use this page to reduce naming drift across new development, APIs, pipeline outputs, and code.
General Rules¶
- prefer stable, lower-case, machine-friendly field names
- use the same join key names across all repos and code when they mean the same thing
- do not rename the same idea differently across API docs, pipeline docs, and lessons without a strong reason
- document the public-facing name when internal code differs
Common Examples¶
| Prefer | Avoid | Why |
|---|---|---|
uid |
id for watershed-specific joins |
clearer for shared spatial joins |
state, district, block |
mixed admin naming in the same example | keeps request examples consistent |
gee_asset_path |
ad hoc GEE path field names | matches public metadata already exposed |
layer_url |
multiple vague download field names | keeps delivery surfaces understandable |
dataset_name |
shifting labels for the same output | makes inventories easier to scan |