Add API v2 deprecated notices

vectara · Dec 19, 2024 · 70eab71 · 70eab71
1 parent f9fc461
commit 70eab71
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 4 deletions.
diff --git a/www/docs/api-reference/overview.md b/www/docs/api-reference/overview.md
@@ -16,11 +16,14 @@ as a roadmap to understanding and using our [gRPC APIs](/docs/api-reference/prot
 such as [managing user access](/docs/api-reference/admin-apis/manage-users/manage-user) and [corpora](/docs/api-reference/admin-apis/admin). Before getting into more
 details, we recommend that you have a basic understanding of API concepts.
 
-:::caution
+:::warning Deprecation Notice
+REST API v1 has been deprecated and will be fully retired on **August 16, 2025**. 
+Please migrate to API v2 as soon as possible.
+:::
 
+:::caution
 Review the [**REST API 1.0 to 2.0 migration guide**](/docs/migration-guide-api-v2) which highlights important
 differences between the Vectara REST API v1 and REST API v2.
-
 :::
 
 ## :star2: Ready to Dive In? Check Out Our API Reference! :star2:

diff --git a/www/docs/api-reference/rest.md b/www/docs/api-reference/rest.md
@@ -12,11 +12,14 @@ of Vectara's REST API 2.0, developers can now leverage a more intuitive and
 user-friendly API design that follows RESTful principles and simplifies the
 getting started experience.
 
-:::caution
+:::warning Deprecation Notice
+REST API v1 has been deprecated and will be fully retired on **August 16, 2025**. 
+Please migrate to API v2 as soon as possible.
+:::
 
+:::caution
 Review the [**REST API 1.0 to 2.0 migration guide**](/docs/migration-guide-api-v2) which highlights important
 differences between the Vectara REST API v1 and REST API v2.
-
 :::
 
 ## API formatting guidelines

diff --git a/www/docs/migration-guide-api-v2.md b/www/docs/migration-guide-api-v2.md
@@ -5,6 +5,16 @@ sidebar_label: Migration Guide from REST API 1.0 to 2.0
 ---
 import {Config} from '@site/docs/definitions.md';
 
+## Key Dates
+- **December 16, 2024**: API v1 deprecation announced.
+- **August 16, 2025**: API v1 will be fully retired.
+
+
+:::warning Deprecation Notice
+API v1 has been deprecated and will be fully retired on **August 16, 2025**. 
+Please migrate to API v2 as soon as possible.
+:::
+
 Migrating to a new API version can be challenging, especially when ensuring 
 that your existing applications continue to function properly. This guide 
 helps you migrate from the Vectara v1 REST API to v2, minimizing 

diff --git a/www/docs/release-notes.mdx b/www/docs/release-notes.mdx
@@ -44,6 +44,29 @@ efficiency and ensures smooth document lifecycle management.
 * [Update Metadata API Definition](/docs/api-reference/indexing-apis/update-document-metadata)
 * [Replace Metadata API Definition](/docs/api-reference/indexing-apis/replace-document-metadata)
 
+## API v1 deprecated
+
+_December 19, 2024_
+
+Vectara announces the official deprecation of API v1, which will be retired on 
+August 16, 2025. This milestone marks a shift towards leveraging the full 
+capabilities of API v2, offering enhanced functionality, improved developer 
+experience, and streamlined authentication mechanisms. Users are encouraged to 
+migrate their applications to API v2 as soon as possible to ensure 
+uninterrupted service.
+
+**Why it matters:** REST API v2 improves upon the previous release with 
+standard HTTP response codes, a more intuitive REST URL structure, and new 
+functionality, such as client-side timeouts. Migrating to API v2 allows users 
+to benefit from these improvements while ensuring long-term platform 
+compatibility.
+
+**More information:**
+
+* [Migration Guide from REST API 1.0 to 2.0](/docs/migration-guide-api-v2)
+* [API v2 Reference](/docs/rest-api)
+* [Vectara APIs Overview](/docs/api-reference/api-overview)
+
 
 ## Querying table data