Skip to content

docs(elevation API): add response explanation and confidence level definition#72

Merged
shimoncohen merged 4 commits intomasterfrom
elevation-api-confidence-level
Jan 4, 2024
Merged

docs(elevation API): add response explanation and confidence level definition#72
shimoncohen merged 4 commits intomasterfrom
elevation-api-confidence-level

Conversation

@shimoncohen
Copy link
Contributor

Question Answer
Bug fix
New feature
Breaking change
Deprecations
Documentation
Tests added
Chore

@shimoncohen shimoncohen added the documentation Improvements or additions to documentation label Dec 23, 2023
@shimoncohen shimoncohen self-assigned this Dec 23, 2023
alebinson
alebinson previously approved these changes Dec 25, 2023
Copy link
Contributor

@alebinson alebinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically approved, but see my comment (feel free to rephrase it)

* `resolutionMeter` - precision on the horizontal plane (may be interpolated), meaning that for every `x` meters there is a value in the mesh
* `absoluteAccuracyLEP90` - each height measurement has a 90% chance to have a deviation of at most `x` meters from the given value (between `height` - `x` and `height` + `x`)

It is extremely important to provide all of the information about the product which the height was extracted from, for each point you query, in order to allow the user to make the best decision based on the data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GOOD, but think that part "in order to allow the user to make the best decision based on the data" is redundant

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed, but added an info banner for the required values to be displayed.

Copy link
Contributor

@syncush syncush left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the open api for elevation ?

@shimoncohen shimoncohen merged commit 5ba2737 into master Jan 4, 2024
@shimoncohen shimoncohen deleted the elevation-api-confidence-level branch January 4, 2024 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants