From e6f20f844cc3dec56ba39e217966a07d9a600f03 Mon Sep 17 00:00:00 2001 From: Matthias Schaub Date: Mon, 13 Jul 2026 11:14:17 +0200 Subject: [PATCH] docs: add deprecation notice --- docs/autodocs.rst | 5 +++++ docs/boundaries.rst | 5 +++++ docs/endpoint-visualisation.rst | 5 +++++ docs/endpoints.rst | 5 +++++ docs/filter.rst | 5 +++++ docs/group-by.rst | 5 +++++ docs/http-response-status.rst | 5 +++++ docs/index.rst | 5 +++++ docs/response-parameters.rst | 5 +++++ docs/time.rst | 7 ++++++- 10 files changed, 51 insertions(+), 1 deletion(-) diff --git a/docs/autodocs.rst b/docs/autodocs.rst index 06156549f..75908d85a 100644 --- a/docs/autodocs.rst +++ b/docs/autodocs.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + Autogenerated Documentation =========================== diff --git a/docs/boundaries.rst b/docs/boundaries.rst index 002bd85b8..25e2d0849 100644 --- a/docs/boundaries.rst +++ b/docs/boundaries.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + Boundaries ========== diff --git a/docs/endpoint-visualisation.rst b/docs/endpoint-visualisation.rst index 973011dc5..76bac993d 100644 --- a/docs/endpoint-visualisation.rst +++ b/docs/endpoint-visualisation.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + API Endpoints Visualisations ============================ diff --git a/docs/endpoints.rst b/docs/endpoints.rst index 2ad937094..4539098b7 100644 --- a/docs/endpoints.rst +++ b/docs/endpoints.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + API Endpoints ============= diff --git a/docs/filter.rst b/docs/filter.rst index 97d7e117f..07ce99353 100644 --- a/docs/filter.rst +++ b/docs/filter.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + Filter ====== diff --git a/docs/group-by.rst b/docs/group-by.rst index 0467445b6..aeefd450b 100644 --- a/docs/group-by.rst +++ b/docs/group-by.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + Grouping ======== The grouping end points are available for every aggregation resource (count, length, perimeter, diff --git a/docs/http-response-status.rst b/docs/http-response-status.rst index c886e6974..edba74abf 100644 --- a/docs/http-response-status.rst +++ b/docs/http-response-status.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + HTTP Response Status ==================== diff --git a/docs/index.rst b/docs/index.rst index 1f3407d05..708eb3998 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,6 +3,11 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + .. image:: https://heigit.org/wp-content/uploads/2018/08/ohsome.png :width: 75% :align: center diff --git a/docs/response-parameters.rst b/docs/response-parameters.rst index 2173195bc..b22bcf2fe 100644 --- a/docs/response-parameters.rst +++ b/docs/response-parameters.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + Response Parameters =================== diff --git a/docs/time.rst b/docs/time.rst index 3b29ceaed..f4ba2e347 100644 --- a/docs/time.rst +++ b/docs/time.rst @@ -1,3 +1,8 @@ +.. attention:: + + With the release of the ohsome API v2 the ohsome API v1 is reaching end-of-life in September 2026. + To migrate to ohsome API v2, refer to the `official documentation `_. + Time ==== @@ -31,4 +36,4 @@ detailed information on timestamp formats and how to use the earliest/latest tim .. note:: If you use the time interval syntax and use an end timestamp that does not perfectly align with the given start timestamp and period, you will get a response where the last result has as an end timestamp value which is the start timestamp plus a multiple of the period, and not one equal to the given end time. For example, if you - use ``2010-01-01/2012-02-01/P1Y``, the actually used final timestamp will be ``2012-01-01``. \ No newline at end of file + use ``2010-01-01/2012-02-01/P1Y``, the actually used final timestamp will be ``2012-01-01``.