Skip to content

Update API documentation when API v4 becomes stable #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lexvand opened this issue Dec 30, 2021 · 1 comment
Open

Update API documentation when API v4 becomes stable #43

lexvand opened this issue Dec 30, 2021 · 1 comment
Assignees

Comments

@lexvand
Copy link
Contributor

lexvand commented Dec 30, 2021

Mainly the section "DATA EXCHANGE" needs to be rewritten when API v4 becomes the stable version. May be prepared by starting a duplicate section specifically for v4.

@lexvand
Copy link
Contributor Author

lexvand commented Dec 16, 2022

I've made some basic changes to convert to v4, especially in API technical and API functional. We need to go through the docs more thoroughly and see what else should be changed.

Also, we should add a guide with the most common use cases that require changes in scripts to convert from using API v4 instead of v3. Apart from the changes mentioned in the announcement email, the main topics to be worked out in examples are:

  • Read and write Timeseries data (endpoint changed from /data to /events + some other changes)
  • Raster-aggregates to rasters sub-endpoints (/point, /line, /curve, et cetera)
  • Raster exports to GeoTIFF (different query parameters)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants