You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by sj...@apache.org on 2015/05/27 11:45:31 UTC
[3/5] incubator-brooklyn git commit: Add new page resources
Add new page resources
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/305adce2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/305adce2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/305adce2
Branch: refs/heads/master
Commit: 305adce215aa22fb2b15257bd4ca03f816ae2d8a
Parents: 0e906ff
Author: Mike Zaccardo <mi...@cloudsoftcorp.com>
Authored: Tue May 26 16:22:50 2015 -0400
Committer: Mike Zaccardo <mi...@cloudsoftcorp.com>
Committed: Tue May 26 16:22:50 2015 -0400
----------------------------------------------------------------------
.../guide/dev/rest/images/rest-api-gui-link.png | Bin 0 -> 43426 bytes
docs/guide/dev/rest/rest-api-doc.md | 19 +++++++++++++++++++
2 files changed, 19 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/305adce2/docs/guide/dev/rest/images/rest-api-gui-link.png
----------------------------------------------------------------------
diff --git a/docs/guide/dev/rest/images/rest-api-gui-link.png b/docs/guide/dev/rest/images/rest-api-gui-link.png
new file mode 100644
index 0000000..f77bf10
Binary files /dev/null and b/docs/guide/dev/rest/images/rest-api-gui-link.png differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/305adce2/docs/guide/dev/rest/rest-api-doc.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/rest/rest-api-doc.md b/docs/guide/dev/rest/rest-api-doc.md
new file mode 100644
index 0000000..c05750c
--- /dev/null
+++ b/docs/guide/dev/rest/rest-api-doc.md
@@ -0,0 +1,19 @@
+---
+title: REST API Documentation
+layout: website-normal
+---
+
+## API Overview
+
+Brooklyn has a comprehensive REST API which can be used to perform all of the actions that
+are possible through the web console, as well as additional functionality exclusive to the API.
+
+Brooklyn uses [Swagger](http://swagger.io/) to generate its REST API and documentation.
+
+## Accessing the API Documentation
+
+The complete REST API can be found in the web console (link pictured below) of your running
+Brooklyn instance.
+Here you can view, as well as execute, every API call that Brooklyn has to offer.
+
+
\ No newline at end of file