Skip to content

Commit

Permalink
Update README to mark 'category', 'type', and 'value' fields as requi…
Browse files Browse the repository at this point in the history 
…red; add 'validity' field description
  • Loading branch information
@emmanuelmathot
emmanuelmathot committed Dec 10, 2024
1 parent 96600bc commit 5555bda
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,12 @@ It is an object that contains the details of the impact estimate. Preferably use

| Field Name | Type | Description |
| ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| category | string | The category of impact, which is the specific asset or population demographic that has been impacted by the hazard. The possible values are defined in [this table](./model/taxonomy.md#exposure-category). |
| type | string | The estimated value type of the impact. The possible values are defined in [this table](./model/taxonomy.md#impact-type). |
| value | number | The estimated impact value, as a number, without the units. |
| category | string | **REQUIRED** The category of impact, which is the specific asset or population demographic that has been impacted by the hazard. The possible values are defined in [this table](./model/taxonomy.md#exposure-category). |
| type | string | **REQUIRED** The estimated value type of the impact. The possible values are defined in [this table](./model/taxonomy.md#impact-type). |
| value | number | **REQUIRED** The estimated impact value, as a number, without the units. |
| unit | string | The units of the impact estimate. |
| datetime | string\|null | If the impact estimate is a cost, provide the date that the estimate was made on, to adjust for currency value and inflation. If no value is provided, `datetime` of the impact will be used. It is formatted according to RFC 3339, section 5.6. |
| validity | \[string] | The validity of the impact estimate as an array of 2 dates (start and end) formatted according to RFC 3339, section 5.6. |
| estimate_type | string | The type of the estimate. The possible values are defined in [this table](./model/taxonomy.md#estimation-type). |

## Relation types
Expand Down

0 comments on commit 5555bda

Please sign in to comment.