Describe the input layer formats
describe_input_kindsReturns each input layer kind's geometry, properties, allowed values, and a minimal example so you can build valid GeoJSON before uploading.
Instructions
Say what each input layer kind looks like: geometry, properties, allowed values, a minimal example.
Read this BEFORE you build GeoJSON for write_input_layer or an upload. Per kind it
returns the geometry (LineString or Polygon), every property the layer reads with its
type, whether it is required and its allowed values or min/max, the
required_one_of groups (an inflow needs data_constant or data_timeseries_id), notes
in plain words and a minimal example FeatureCollection. It is generated by Hydrata from
the same definitions the build reads, so it is never out of date: do not read source code
or guess column names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | One kind to describe (boundary, friction, inflow, rainfall, building, mesh_region or culvert); empty describes all seven |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||