brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henev...@apache.org
Subject [31/50] brooklyn-docs git commit: Add new page resources
Date Mon, 01 Feb 2016 17:44:46 GMT
Add new page resources


Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/10f8a5dd
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/10f8a5dd
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/10f8a5dd

Branch: refs/heads/0.7.0-incubating
Commit: 10f8a5dd62ac726b10fd6bd78a292f34dbc2d214
Parents: fcf38fa
Author: Mike Zaccardo <mike.zaccardo@cloudsoftcorp.com>
Authored: Tue May 26 16:22:50 2015 -0400
Committer: Mike Zaccardo <mike.zaccardo@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/brooklyn-docs/blob/10f8a5dd/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/brooklyn-docs/blob/10f8a5dd/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.
+
+![Brooklyn web console, showing the link to the REST API documentation.](images/rest-api-gui-link.png)

\ No newline at end of file


Mime
View raw message