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

Add documentation for API v2 #1727

Merged
merged 2 commits into from
Aug 31, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ Documentation for Snap will be kept in this repository for now with an emphasis
* [configuring snapteld](docs/SNAPTELD_CONFIGURATION.md)
* [snaptel (Snap CLI)](docs/SNAPTEL.md)
* [build and test](docs/BUILD_AND_TEST.md)
* [REST API](docs/REST_API.md)
* [REST API V1](docs/REST_API_V1.md)
* [tasks](docs/TASKS.md)
* [plugin life cycle](docs/PLUGIN_LIFECYCLE.md)
* [plugin signing](docs/PLUGIN_SIGNING.md)
Expand Down
25 changes: 17 additions & 8 deletions docs/REST_API.md → docs/REST_API_V1.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# Notice
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:
> http://localhost:8181
Expand All @@ -13,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
Loading