Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
Extend info about API v2
Browse files Browse the repository at this point in the history
  • Loading branch information
kdembler committed Aug 31, 2017
1 parent 17eb9d5 commit 8015030
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
24 changes: 15 additions & 9 deletions docs/REST_API_V1.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -16,17 +22,17 @@ Snap exposes a list of RESTful APIs to perform various actions. All of Snap's AP
## API Index
1. [Authentication](#authentication)
2. [Plugin API](#plugin-api)
* [Plugin Response Parameters](#plugin-response-parameters)
* [Plugin APIs and Examples](#plugin-apis-and-examples)
* [Plugin Response Parameters](#plugin-response-parameters)
* [Plugin APIs and Examples](#plugin-apis-and-examples)
3. [Metric API](#metric-api)
* [Metric Response Parameters](#metric-response-parameters)
* [Metric APIs and Examples](#metric-apis-and-examples)
* [Metric Response Parameters](#metric-response-parameters)
* [Metric APIs and Examples](#metric-apis-and-examples)
4. [Task API](#task-api)
* [Task API Response Parameters](#task-api-response-parameters)
* [Task APIs and Examples](#task-apis-and-examples)
* [Task API Response Parameters](#task-api-response-parameters)
* [Task APIs and Examples](#task-apis-and-examples)
5. [Tribe API](#tribe-api)
* [Tribe API Response Parameters](#tribe-api-response-parameters)
* [Tribe APIs and Examples](#tribe-apis-and-examples)
* [Tribe API Response Parameters](#tribe-api-response-parameters)
* [Tribe APIs and Examples](#tribe-apis-and-examples)

### Authentication
Enabled in snapteld
Expand Down
14 changes: 7 additions & 7 deletions docs/REST_API_V2.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# 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
## API Index
1. [Authentication](#authentication)
2. [Plugin API](#plugin-api)
* [Plugin Response Parameters](#plugin-response-parameters)
* [Plugin API endpoints and examples](#plugin-api-endpoints-and-examples)
* [Plugin Response Parameters](#plugin-response-parameters)
* [Plugin API endpoints and examples](#plugin-api-endpoints-and-examples)
3. [Metric API](#metric-api)
* [Metric Response Parameters](#metric-response-parameters)
* [Metric API endpoints and examples](#metric-api-endpoints-and-examples)
* [Metric Response Parameters](#metric-response-parameters)
* [Metric API endpoints and examples](#metric-api-endpoints-and-examples)
4. [Task API](#task-api)
* [Task API Response Parameters](#task-api-response-parameters)
* [Task API endpoints and examples](#task-api-endpoints-and-examples)
* [Task API Response Parameters](#task-api-response-parameters)
* [Task API endpoints and examples](#task-api-endpoints-and-examples)

### Authentication
If Snap framework is started with `--rest-auth` flag, then all requests without authentication info provided will be unauthorized:
Expand Down

0 comments on commit 8015030

Please sign in to comment.