Extend info about API v2

intelsdi-x · Aug 31, 2017 · e968cff · e968cff
1 parent 17eb9d5
commit e968cff
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/docs/REST_API_V1.md b/docs/REST_API_V1.md
@@ -1,5 +1,11 @@
 # Notice
-This document describes API v1, for info about API v2 see [REST_API_V2.md](REST_API_V2.md).
+This document describes API v1, which is currently supported, but no longer in active development.
+
+In the future, it will be fully replaced by [API_v2](REST_API_V2.md) - see details in [issue 1637](https://github.com/intelsdi-x/snap/issues/1637).
+
+**Notice that [Tribe API](#tribe-api) is available only in API v1 at the moment.**
+
+The process of deprecation will start only after API v2 achieves full feature parity with API v1 (adding Tribe API) and will be preceded by an deprecation announcement giving Snap users time to switch to API v2.
 
 # Snap API
 Snap exposes a list of RESTful APIs to perform various actions. All of Snap's API requests return `JSON`-formatted responses, including errors. Any non-2xx HTTP status code may contain an error message. All API URLs listed in this documentation have the endpoint:

diff --git a/docs/REST_API_V2.md b/docs/REST_API_V2.md
@@ -1,4 +1,4 @@
-# Snap API
+# Snap API v2
 Snap exposes RESTful APIs that allow performing various actions. All of Snap's API requests return `JSON`-formatted responses, including errors. Any non-2xx HTTP status code may contain an error message. All API URLs listed in this documentation have the endpoint:
 > http://localhost:8181