Skip to content

Commit 09bed98

Browse files
committed
add deprecation warning
1 parent 5bea37a commit 09bed98

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/content/docs/about/about.md src/content/docs/about/about.mdx

+9
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ description:
1111
donation.
1212
---
1313

14+
import { Aside } from '@astrojs/starlight/components';
15+
1416
The OpenAQ API provides open access to global air quality data, following REST
1517
principles with resource-oriented URLs, standard HTTP response codes, and
1618
JSON-formatted responses. OpenAQ focuses on criteria air pollutants, primarily
@@ -34,6 +36,13 @@ section but all other content in this guide pertains to version 3. To get
3436
started, explore the available endpoints and consult the documentation for
3537
guidance.
3638

39+
<Aside type="danger" title="Deprecation">
40+
The OpenAQ version 1 and version 2 endpoints are being retired on January 31,
41+
2025 and after which will no longer be accessible. Please migrate all existing
42+
code to version 3 as soon as possible to avoid disruptions. After January 31,
43+
2025 `/v1` and `/v2` endpoints will return HTTP 410 Gone responses.
44+
</Aside>
45+
3746
---
3847

3948
This repository of global air quality data is brought to you by

0 commit comments

Comments
 (0)