This repository has been archived by the owner on Nov 8, 2022. It is now read-only.
Add documentation for API v2 #1727
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/REST_API_V2.md
Outdated
| @@ -0,0 +1,529 @@ | |||
| # Snap API | |||
docs/REST_API_V1.md
Outdated
| @@ -1,3 +1,6 @@ | |||
| # Notice | |||
| This document describes API v1, for info about API v2 see [REST_API_V2.md](REST_API_V2.md). | |||
There was a problem hiding this comment.
Consider adding sth like that:
This document describes API v1 - it is supported, but no longer in active development.
In the future, it will be fully replaced by REST_API_V2.md - see details in the issue 1637.
Notice, that Tribe API is available only in REST API V1 at the moment.
REST API V2 is under development - below is the table presenting the status of work presenting what still needs to be implemented to start the process of deprecation V1:
The process of depreciation will be preceded by an announcement and giving time to switch Snap users to REST API V2.
kdembler
force-pushed
the
api-v2-docs
branch
2 times, most recently
from
44fcf2c
to
8015030
Compare
IzabellaRaulin
approved these changes
Aug 31, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1254
Summary of changes:
REST_API_V2.mdwith descriptions of API v2 endpointsREST_API.mdtoREST_API_V1.mdand changed all links pointing to it@intelsdi-x/snap-maintainers