You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ambari.apache.org by tb...@apache.org on 2014/05/19 20:23:01 UTC
git commit: AMBARI-5810 - Views : Update ambari-views/examples docs.
Repository: ambari
Updated Branches:
refs/heads/trunk dd85e2feb -> 742f5af65
AMBARI-5810 - Views : Update ambari-views/examples docs.
Project: http://git-wip-us.apache.org/repos/asf/ambari/repo
Commit: http://git-wip-us.apache.org/repos/asf/ambari/commit/742f5af6
Tree: http://git-wip-us.apache.org/repos/asf/ambari/tree/742f5af6
Diff: http://git-wip-us.apache.org/repos/asf/ambari/diff/742f5af6
Branch: refs/heads/trunk
Commit: 742f5af65f4acc5de2fdcce272c839647eafc489
Parents: dd85e2f
Author: tbeerbower <tb...@hortonworks.com>
Authored: Mon May 19 14:03:01 2014 -0400
Committer: tbeerbower <tb...@hortonworks.com>
Committed: Mon May 19 14:22:36 2014 -0400
----------------------------------------------------------------------
.../examples/calculator-view/docs/add.png | Bin 23104 -> 25490 bytes
.../examples/calculator-view/docs/index.md | 55 +--
.../examples/calculator-view/docs/usage.png | Bin 36210 -> 48294 bytes
.../hello-servlet-view/docs/hello_1.png | Bin 17248 -> 17767 bytes
.../hello-servlet-view/docs/hello_2.png | Bin 14443 -> 17052 bytes
.../examples/hello-servlet-view/docs/index.md | 91 +++--
.../helloworld-view/docs/hello_world.png | Bin 17467 -> 18761 bytes
.../examples/helloworld-view/docs/index.md | 49 +--
.../examples/phone-list-view/docs/index.md | 97 ++---
.../examples/phone-list-view/docs/phone_1.png | Bin 45394 -> 37944 bytes
.../examples/phone-list-view/docs/phone_2.png | Bin 10651 -> 26073 bytes
.../examples/phone-list-view/docs/phone_3.png | Bin 27134 -> 35462 bytes
.../examples/phone-list-view/docs/phone_5.png | Bin 30323 -> 37989 bytes
.../examples/weather-view/docs/index.md | 392 +++++++++----------
.../examples/weather-view/docs/paloalto.png | Bin 0 -> 39530 bytes
.../examples/weather-view/docs/portland.png | Bin 34597 -> 0 bytes
.../examples/weather-view/docs/weather.png | Bin 25611 -> 29121 bytes
17 files changed, 349 insertions(+), 335 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/calculator-view/docs/add.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/calculator-view/docs/add.png b/ambari-views/examples/calculator-view/docs/add.png
index 28555d2..3a0e14f 100644
Binary files a/ambari-views/examples/calculator-view/docs/add.png and b/ambari-views/examples/calculator-view/docs/add.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/calculator-view/docs/index.md
----------------------------------------------------------------------
diff --git a/ambari-views/examples/calculator-view/docs/index.md b/ambari-views/examples/calculator-view/docs/index.md
index 7898923..5d9b505 100644
--- a/ambari-views/examples/calculator-view/docs/index.md
+++ b/ambari-views/examples/calculator-view/docs/index.md
@@ -117,58 +117,63 @@ After deploying a view you should see it as a view resource in the Ambari REST A
If we want to see the details about a specific view, we can ask for it by name. This shows us that the CALCULATOR view has a single instance named INSTANCE_1.
- http://<server>:8080/api/v1/views/CALCULATOR/
+ http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0
{
- "href" : "http://<server>:8080/api/v1/views/CALCULATOR/",
- "ViewInfo" : {
- "archive" : "/var/lib/ambari-server/resources/views/calculator-view-1.0.0.jar",
- "label" : "The Calculator View",
- "parameters" : [ ],
- "version" : "1.0.0",
- "view_name" : "CALCULATOR"
- },
- "instances" : [
- {
- "href" : "http://<server>:8080/api/v1/views/CALCULATOR/instances/INSTANCE_1",
- "ViewInstanceInfo" : {
- "instance_name" : "INSTANCE_1",
- "view_name" : "CALCULATOR"
- }
+ "href" : "http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0",
+ "ViewVersionInfo" : {
+ "archive" : "/var/lib/ambari-server/resources/views/work/CALCULATOR{1.0.0}",
+ "label" : "The Calculator View",
+ "parameters" : [ ],
+ "version" : "1.0.0",
+ "view_name" : "CALCULATOR"
+ },
+ "instances" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0/instances/INSTANCE_1",
+ "ViewInstanceInfo" : {
+ "instance_name" : "INSTANCE_1",
+ "version" : "1.0.0",
+ "view_name" : "CALCULATOR"
}
- ]
- }
+ }
+ ]
+ }
To see a specific instance of a view, we can ask for it by name. Here we can see the attributes of the view instance. We can also see that this view has a resource name 'calculator'.
- http://<server>:8080/api/v1/views/CALCULATOR/instances/INSTANCE_1
+ http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0/instances/INSTANCE_1
{
- "href" : "http://<server>:8080/api/v1/views/CALCULATOR/instances/INSTANCE_1",
+ "href" : "http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0/instances/INSTANCE_1",
"ViewInstanceInfo" : {
- "context_path" : "/views/CALCULATOR/INSTANCE_1",
+ "context_path" : "/views/CALCULATOR/1.0.0/INSTANCE_1",
"instance_name" : "INSTANCE_1",
+ "version" : "1.0.0",
"view_name" : "CALCULATOR",
+ "instance_data" : { },
"properties" : { }
},
"resources" : [
{
- "href" : "http://<server>:8080/api/v1/views/CALCULATOR/instances/INSTANCE_1/resources/calculator",
+ "href" : "http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0/instances/INSTANCE_1/resources/calculator",
"instance_name" : "INSTANCE_1",
"name" : "calculator",
+ "version" : "1.0.0",
"view_name" : "CALCULATOR"
}
]
}
-
+
We can access the view's resource through the resource's href.
- http://<server>:8080/api/v1/views/CALCULATOR/instances/INSTANCE_1/resources/calculator
+ http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0/instances/INSTANCE_1/resources/calculator/
We can access the add method of the resource with the following …
- http://<server>:8080/api/v1/views/CALCULATOR/instances/INSTANCE_1/resources/calculator/add/77.5/87.62
+ http://<server>:8080/api/v1/views/CALCULATOR/versions/1.0.0/instances/INSTANCE_1/resources/calculator/add/77.5/87.62
+
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/calculator-view/docs/usage.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/calculator-view/docs/usage.png b/ambari-views/examples/calculator-view/docs/usage.png
index 207d31f..028055e 100644
Binary files a/ambari-views/examples/calculator-view/docs/usage.png and b/ambari-views/examples/calculator-view/docs/usage.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/hello-servlet-view/docs/hello_1.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/hello-servlet-view/docs/hello_1.png b/ambari-views/examples/hello-servlet-view/docs/hello_1.png
index 845bc68..e850c46 100644
Binary files a/ambari-views/examples/hello-servlet-view/docs/hello_1.png and b/ambari-views/examples/hello-servlet-view/docs/hello_1.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/hello-servlet-view/docs/hello_2.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/hello-servlet-view/docs/hello_2.png b/ambari-views/examples/hello-servlet-view/docs/hello_2.png
index bea65ab..04b48b2 100644
Binary files a/ambari-views/examples/hello-servlet-view/docs/hello_2.png and b/ambari-views/examples/hello-servlet-view/docs/hello_2.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/hello-servlet-view/docs/index.md
----------------------------------------------------------------------
diff --git a/ambari-views/examples/hello-servlet-view/docs/index.md b/ambari-views/examples/hello-servlet-view/docs/index.md
index 7e91f12..5932f2c 100644
--- a/ambari-views/examples/hello-servlet-view/docs/index.md
+++ b/ambari-views/examples/hello-servlet-view/docs/index.md
@@ -158,58 +158,63 @@ After deploying a view you should see it as a view resource in the Ambari REST A
If we want to see the details about a specific view, we can ask for it by name. This shows us that the HELLO_SERVLET view defines a single 'name' parameter and has a three instances.
- http://<server>:8080/api/v1/views/HELLO_SERVLET/
+ http://<server>:8080/api/v1/views/HELLO_SERVLET/versions/1.0.0/
{
- "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/",
- "ViewInfo" : {
- "archive" : "/var/lib/ambari-server/resources/views/hello-servlet-view-1.0.0.jar",
- "label" : "The Hello Servlet View!",
- "parameters" : [
- {
- "name" : "name",
- "description" : "The name for the greeting. Defaults to current user.",
- "required" : false
- }
- ],
- "version" : "1.0.0",
- "view_name" : "HELLO_SERVLET"
- },
- "instances" : [
- {
- "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/instances/JERRY",
- "ViewInstanceInfo" : {
- "instance_name" : "JERRY",
- "view_name" : "HELLO_SERVLET"
- }
- },
+ "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/versions/1.0.0/",
+ "ViewVersionInfo" : {
+ "archive" : "/var/lib/ambari-server/resources/views/work/HELLO_SERVLET{1.0.0}",
+ "label" : "The Hello Servlet View!",
+ "parameters" : [
{
- "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/instances/TOM",
- "ViewInstanceInfo" : {
- "instance_name" : "TOM",
- "view_name" : "HELLO_SERVLET"
- }
- },
- {
- "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/instances/USER",
- "ViewInstanceInfo" : {
- "instance_name" : "USER",
- "view_name" : "HELLO_SERVLET"
- }
+ "name" : "name",
+ "description" : "The name for the greeting. Defaults to current user.",
+ "required" : false
}
- ]
- }
-
+ ],
+ "version" : "1.0.0",
+ "view_name" : "HELLO_SERVLET"
+ },
+ "instances" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/versions/1.0.0/instances/JERRY",
+ "ViewInstanceInfo" : {
+ "instance_name" : "JERRY",
+ "version" : "1.0.0",
+ "view_name" : "HELLO_SERVLET"
+ }
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/versions/1.0.0/instances/TOM",
+ "ViewInstanceInfo" : {
+ "instance_name" : "TOM",
+ "version" : "1.0.0",
+ "view_name" : "HELLO_SERVLET"
+ }
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/versions/1.0.0/instances/USER",
+ "ViewInstanceInfo" : {
+ "instance_name" : "USER",
+ "version" : "1.0.0",
+ "view_name" : "HELLO_SERVLET"
+ }
+ }
+ ]
+ }
+
To see a specific instance of a view, we can ask for it by name. Here we can see the attributes of the view including its name and root context path. We can also see that this view instance defines a value for the name property.
- http://<server>:8080/api/v1/views/HELLO_SERVLET/instances/TOM
+ http://<server>:8080/api/v1/views/HELLO_SERVLET/versions/1.0.0/instances/TOM
{
- "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/instances/TOM",
+ "href" : "http://<server>:8080/api/v1/views/HELLO_SERVLET/versions/1.0.0/instances/TOM",
"ViewInstanceInfo" : {
- "context_path" : "/views/HELLO_SERVLET/TOM",
+ "context_path" : "/views/HELLO_SERVLET/1.0.0/TOM",
"instance_name" : "TOM",
+ "version" : "1.0.0",
"view_name" : "HELLO_SERVLET",
+ "instance_data" : { },
"properties" : {
"name" : "Tom"
}
@@ -219,12 +224,12 @@ To see a specific instance of a view, we can ask for it by name. Here we can se
If the view contains any web content, we can access it at the view's root context path. In this case its the HelloServlet which displays a greeting customized to the view instance.
- http://<server>:8080/views/HELLO_SERVLET/JERRY/
+ http://<server>:8080/views/HELLO_SERVLET/1.0.0/JERRY/
- http://<server>:8080/views/HELLO_SERVLET/TOM/
+ http://<server>:8080/views/HELLO_SERVLET/1.0.0/TOM
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/helloworld-view/docs/hello_world.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/helloworld-view/docs/hello_world.png b/ambari-views/examples/helloworld-view/docs/hello_world.png
index bc8b67c..9b873c6 100644
Binary files a/ambari-views/examples/helloworld-view/docs/hello_world.png and b/ambari-views/examples/helloworld-view/docs/hello_world.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/helloworld-view/docs/index.md
----------------------------------------------------------------------
diff --git a/ambari-views/examples/helloworld-view/docs/index.md b/ambari-views/examples/helloworld-view/docs/index.md
index 66e1e6a..80b100b 100644
--- a/ambari-views/examples/helloworld-view/docs/index.md
+++ b/ambari-views/examples/helloworld-view/docs/index.md
@@ -98,38 +98,41 @@ After deploying a view you should see it as a view resource in the Ambari REST A
If we want to see the details about a specific view, we can ask for it by name. This shows us that the HELLO_WORLD view does not define any parameters and has a single instance named INSTANCE_1.
- http://<server>:8080/api/v1/views/HELLO_WORLD/
+ http://<server>:8080/api/v1/views/HELLO_WORLD/versions/1.0.0/
- {
- "href" : "http://<server>:8080/api/v1/views/HELLO_WORLD/",
- "ViewInfo" : {
- "archive" : "/var/lib/ambari-server/resources/views/helloworld-view-1.0.0.jar",
- "label" : "The Hello World View!",
- "parameters" : [ ],
- "version" : "1.0.0",
- "view_name" : "HELLO_WORLD"
- },
- "instances" : [
- {
- "href" : "http://<server>:8080/api/v1/views/HELLO_WORLD/instances/INSTANCE_1",
- "ViewInstanceInfo" : {
- "instance_name" : "INSTANCE_1",
- "view_name" : "HELLO_WORLD"
- }
+ {
+ "href" : "http://<server>:8080/api/v1/views/HELLO_WORLD/versions/1.0.0/",
+ "ViewVersionInfo" : {
+ "archive" : "/var/lib/ambari-server/resources/views/work/HELLO_WORLD{1.0.0}",
+ "label" : "The Hello World View!",
+ "parameters" : [ ],
+ "version" : "1.0.0",
+ "view_name" : "HELLO_WORLD"
+ },
+ "instances" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/HELLO_WORLD/versions/1.0.0/instances/INSTANCE_1",
+ "ViewInstanceInfo" : {
+ "instance_name" : "INSTANCE_1",
+ "version" : "1.0.0",
+ "view_name" : "HELLO_WORLD"
}
- ]
- }
+ }
+ ]
+ }
To see a specific instance of a view, we can ask for it by name. Here we can see the attributes of the view including its name and root context path. We can also see that this view instance does not define any properties or resources.
- http://<server>:8080/api/v1/views/HELLO_WORLD/instances/INSTANCE_1
+ http://<server>:8080/api/v1/views/HELLO_WORLD/versions/1.0.0/instances/INSTANCE_1
{
- "href" : "http://<server>:8080/api/v1/views/HELLO_WORLD/instances/INSTANCE_1",
+ "href" : "http://<server>:8080/api/v1/views/HELLO_WORLD/versions/1.0.0/instances/INSTANCE_1",
"ViewInstanceInfo" : {
- "context_path" : "/views/HELLO_WORLD/INSTANCE_1",
+ "context_path" : "/views/HELLO_WORLD/1.0.0/INSTANCE_1",
"instance_name" : "INSTANCE_1",
+ "version" : "1.0.0",
"view_name" : "HELLO_WORLD",
+ "instance_data" : { },
"properties" : { }
},
"resources" : [ ]
@@ -137,7 +140,7 @@ To see a specific instance of a view, we can ask for it by name. Here we can se
If the view contains any web content, we can access it at the view's root context path. In this case its the index.html which displays Hello world!
- http://<server>:8080/views/HELLO_WORLD/INSTANCE_1/
+ http://<server>:8080/views/HELLO_WORLD/1.0.0/INSTANCE_1/
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/phone-list-view/docs/index.md
----------------------------------------------------------------------
diff --git a/ambari-views/examples/phone-list-view/docs/index.md b/ambari-views/examples/phone-list-view/docs/index.md
index 3b46f97..ae37a6e 100644
--- a/ambari-views/examples/phone-list-view/docs/index.md
+++ b/ambari-views/examples/phone-list-view/docs/index.md
@@ -179,27 +179,31 @@ After deploying a view you should see it as a view resource in the Ambari REST A
If we want to see the details about a specific view, we can ask for it by name. This shows us that the PHONE_LIST view has a two instances.
+ http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/
+
{
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/",
- "ViewInfo" : {
- "archive" : "/var/lib/ambari-server/resources/views/phone-list-view-1.0.0.jar",
- "label" : "The Phone List View",
- "parameters" : [ ],
- "version" : "1.0.0",
- "view_name" : "PHONE_LIST"
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/",
+ "ViewVersionInfo" : {
+ "archive" : "/var/lib/ambari-server/resources/views/work/PHONE_LIST{1.0.0}",
+ "label" : "The Phone List View",
+ "parameters" : [ ],
+ "version" : "1.0.0",
+ "view_name" : "PHONE_LIST"
},
"instances" : [
{
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_1",
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_1",
"ViewInstanceInfo" : {
"instance_name" : "LIST_1",
+ "version" : "1.0.0",
"view_name" : "PHONE_LIST"
}
},
{
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_2",
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_2",
"ViewInstanceInfo" : {
"instance_name" : "LIST_2",
+ "version" : "1.0.0",
"view_name" : "PHONE_LIST"
}
}
@@ -208,20 +212,16 @@ If we want to see the details about a specific view, we can ask for it by name.
To see a specific instance of a view, we can ask for it by name. Here we can see the attributes of the view including its name and root context path. We can also see that this view instance defines a value for the name property.
- http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_1
+ http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_1
{
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_1",
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_1",
"ViewInstanceInfo" : {
- "context_path" : "/views/PHONE_LIST/LIST_1",
+ "context_path" : "/views/PHONE_LIST/1.0.0/LIST_1",
"instance_name" : "LIST_1",
+ "version" : "1.0.0",
"view_name" : "PHONE_LIST",
- "instance_data" : {
- "Dave" : "999 999 9923",
- "Fred" : "123 678 1234",
- "Karl" : "888 888 8788",
- "Mary" : "888 888 8788"
- },
+ "instance_data" : { },
"properties" : { }
},
"resources" : [ ]
@@ -229,11 +229,11 @@ To see a specific instance of a view, we can ask for it by name. Here we can se
If the view contains any web content, we can access it at the view's root context path. In this case its the PhoneListServlet which displays a list of phone number entries for the view instance.
- http://<server>:8080/views/PHONE_LIST/LIST_1/
+ http://<server>:8080/views/PHONE_LIST/1.0.0/LIST_1/
-Use the view API to add new numbers to the phone list. Click on any name in the list to edit or delete a number…
+Use the view API to add new numbers to the phone list. Click on any name in the list to edit or delete a number
@@ -253,39 +253,40 @@ We can look at the Ambari database and see that the view instance data is being
Notice that the two instances above were defined in the view.xml for the Phone List view. We can also create new instances through the API. For example, if you POST the following…
- POST http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_3
+ POST http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_3
You should then see a new instance named LIST_3 for the Phone List view …
- http://<server>:8080/api/v1/views/PHONE_LIST/instances/
-
{
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/instances/",
- "items" : [
- {
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_1",
- "ViewInstanceInfo" : {
- "instance_name" : "LIST_1",
- "view_name" : "PHONE_LIST"
- }
- },
- {
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_2",
- "ViewInstanceInfo" : {
- "instance_name" : "LIST_2",
- "view_name" : "PHONE_LIST"
- }
- },
- {
- "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/instances/LIST_3",
- "ViewInstanceInfo" : {
- "instance_name" : "LIST_3",
- "view_name" : "PHONE_LIST"
- }
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/",
+ "items" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_1",
+ "ViewInstanceInfo" : {
+ "instance_name" : "LIST_1",
+ "version" : "1.0.0",
+ "view_name" : "PHONE_LIST"
}
- ]
- }
-
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_2",
+ "ViewInstanceInfo" : {
+ "instance_name" : "LIST_2",
+ "version" : "1.0.0",
+ "view_name" : "PHONE_LIST"
+ }
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/PHONE_LIST/versions/1.0.0/instances/LIST_3",
+ "ViewInstanceInfo" : {
+ "instance_name" : "LIST_3",
+ "version" : "1.0.0",
+ "view_name" : "PHONE_LIST"
+ }
+ }
+ ]
+ }
+
You can then access the new instance UI to add, edit and delete numbers for the new list …
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/phone-list-view/docs/phone_1.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/phone-list-view/docs/phone_1.png b/ambari-views/examples/phone-list-view/docs/phone_1.png
index 2a39101..ccfca2d 100644
Binary files a/ambari-views/examples/phone-list-view/docs/phone_1.png and b/ambari-views/examples/phone-list-view/docs/phone_1.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/phone-list-view/docs/phone_2.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/phone-list-view/docs/phone_2.png b/ambari-views/examples/phone-list-view/docs/phone_2.png
index e9efb22..9d44a32 100644
Binary files a/ambari-views/examples/phone-list-view/docs/phone_2.png and b/ambari-views/examples/phone-list-view/docs/phone_2.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/phone-list-view/docs/phone_3.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/phone-list-view/docs/phone_3.png b/ambari-views/examples/phone-list-view/docs/phone_3.png
index ba886e6..b0d4fcd 100644
Binary files a/ambari-views/examples/phone-list-view/docs/phone_3.png and b/ambari-views/examples/phone-list-view/docs/phone_3.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/phone-list-view/docs/phone_5.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/phone-list-view/docs/phone_5.png b/ambari-views/examples/phone-list-view/docs/phone_5.png
index 53d2d9b..a9adc42 100644
Binary files a/ambari-views/examples/phone-list-view/docs/phone_5.png and b/ambari-views/examples/phone-list-view/docs/phone_5.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/weather-view/docs/index.md
----------------------------------------------------------------------
diff --git a/ambari-views/examples/weather-view/docs/index.md b/ambari-views/examples/weather-view/docs/index.md
index da3d9b5..432971e 100644
--- a/ambari-views/examples/weather-view/docs/index.md
+++ b/ambari-views/examples/weather-view/docs/index.md
@@ -295,77 +295,84 @@ After deploying a view you should see it as a view resource in the Ambari REST A
If we want to see the details about a specific view, we can ask for it by name. This shows us that the WEATHER view has multiple parameters and multiple instances.
- http://<server>:8080/api/v1/views/WEATHER/
-
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/",
- "ViewInfo" : {
- "archive" : "/var/lib/ambari-server/resources/views/weather-view-1.0.0.jar",
- "label" : "Weather",
- "parameters" : [
- {
- "name" : "cities",
- "description" : "The list of cities.",
- "required" : true
- },
- {
- "name" : "units",
- "description" : "The units (metric or imperial).",
- "required" : false
- }
- ],
- "version" : "1.0.0",
- "view_name" : "WEATHER"
- },
- "instances" : [
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/EUROPE",
- "ViewInstanceInfo" : {
- "instance_name" : "EUROPE",
- "view_name" : "WEATHER"
- }
- },
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_CENTRAL",
- "ViewInstanceInfo" : {
- "instance_name" : "US_CENTRAL",
- "view_name" : "WEATHER"
- }
- },
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_EAST",
- "ViewInstanceInfo" : {
- "instance_name" : "US_EAST",
- "view_name" : "WEATHER"
- }
- },
+ http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0
+
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0",
+ "ViewVersionInfo" : {
+ "archive" : "/var/lib/ambari-server/resources/views/work/WEATHER{1.0.0}",
+ "label" : "Weather",
+ "parameters" : [
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_MOUNTAIN",
- "ViewInstanceInfo" : {
- "instance_name" : "US_MOUNTAIN",
- "view_name" : "WEATHER"
- }
+ "name" : "cities",
+ "description" : "The list of cities.",
+ "required" : true
},
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST",
- "ViewInstanceInfo" : {
- "instance_name" : "US_WEST",
- "view_name" : "WEATHER"
- }
+ "name" : "units",
+ "description" : "The units (metric or imperial).",
+ "required" : false
}
- ]
- }
-
+ ],
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
+ },
+ "instances" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/EUROPE",
+ "ViewInstanceInfo" : {
+ "instance_name" : "EUROPE",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
+ }
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_CENTRAL",
+ "ViewInstanceInfo" : {
+ "instance_name" : "US_CENTRAL",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
+ }
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_EAST",
+ "ViewInstanceInfo" : {
+ "instance_name" : "US_EAST",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
+ }
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_MOUNTAIN",
+ "ViewInstanceInfo" : {
+ "instance_name" : "US_MOUNTAIN",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
+ }
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST",
+ "ViewInstanceInfo" : {
+ "instance_name" : "US_WEST",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
+ }
+ }
+ ]
+ }
+
To see a specific instance of a view, we can ask for it by name. Here we can see the attributes of the view including its name and root context path. We can also see that this view instance defines a value for the name property.
- http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST
+ http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/",
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST",
"ViewInstanceInfo" : {
- "context_path" : "/views/WEATHER/US_WEST",
+ "context_path" : "/views/WEATHER/1.0.0/US_WEST",
"instance_name" : "US_WEST",
+ "version" : "1.0.0",
"view_name" : "WEATHER",
+ "instance_data" : { },
"properties" : {
"cities" : "Palo Alto, US;Los Angeles, US;Portland, US;Seattle, US",
"units" : "imperial"
@@ -374,193 +381,186 @@ To see a specific instance of a view, we can ask for it by name. Here we can se
"resources" : [ ],
"cities" : [
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Los Angeles, US",
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST/cities/Los Angeles, US",
"id" : "Los Angeles, US",
"instance_name" : "US_WEST",
+ "version" : "1.0.0",
"view_name" : "WEATHER"
},
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Palo Alto, US",
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST/cities/Palo Alto, US",
"id" : "Palo Alto, US",
"instance_name" : "US_WEST",
+ "version" : "1.0.0",
"view_name" : "WEATHER"
},
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Portland, US",
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST/cities/Portland, US",
"id" : "Portland, US",
"instance_name" : "US_WEST",
+ "version" : "1.0.0",
"view_name" : "WEATHER"
},
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Seattle, US",
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST/cities/Seattle, US",
"id" : "Seattle, US",
"instance_name" : "US_WEST",
+ "version" : "1.0.0",
"view_name" : "WEATHER"
}
]
}
-
+
To see a specific city sub-resource we can ask for it by name. Here we can see the city resource for Palo Alto.
- http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Palo Alto, US
+ http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST/cities/Palo%20Alto,%20US
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Palo Alto, US",
- "id" : "Palo Alto, US",
- "instance_name" : "US_WEST",
- "units" : "imperial",
- "view_name" : "WEATHER",
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_WEST/cities/Palo Alto, US",
+ "id" : "Palo Alto, US",
+ "instance_name" : "US_WEST",
+ "units" : "imperial",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER",
+ "weather" : {
+ "base" : "cmc stations",
+ "cod" : 200.0,
+ "dt" : 1.400170204E9,
+ "icon_src" : "http://openweathermap.org/img/w/01d",
+ "id" : 5567220.0,
+ "name" : "Palo Alto",
+ "clouds" : {
+ "all" : 0.0
+ },
+ "coord" : {
+ "lat" : 37.44,
+ "lon" : -122.16
+ },
+ "main" : {
+ "grnd_level" : 1021.91,
+ "humidity" : 87.0,
+ "pressure" : 1021.91,
+ "sea_level" : 1033.86,
+ "temp" : 56.98,
+ "temp_max" : 56.98,
+ "temp_min" : 56.98
+ },
+ "sys" : {
+ "country" : "United States of America",
+ "message" : 0.3532,
+ "sunrise" : 1.400158725E9,
+ "sunset" : 1.400209875E9
+ },
"weather" : {
- "base" : "cmc stations",
- "cod" : 200.0,
- "dt" : 1.392507995E9,
- "icon_src" : "http://openweathermap.org/img/w/04d",
- "id" : 5380748.0,
- "name" : "Palo Alto",
- "clouds" : {
- "all" : 92.0
- },
- "coord" : {
- "lat" : 37.44,
- "lon" : -122.14
- },
- "main" : {
- "humidity" : 82.0,
- "pressure" : 969.0,
- "temp" : 59.2,
- "temp_max" : 62.01,
- "temp_min" : 55.99
- },
- "sys" : {
- "country" : "US",
- "message" : 0.0116,
- "sunrise" : 1.392562529E9,
- "sunset" : 1.392601779E9
- },
- "weather" : {
- "description" : "overcast clouds",
- "icon" : "04d",
- "id" : 804.0,
- "main" : "Clouds"
- },
- "wind" : {
- "deg" : 159.001,
- "speed" : 4.54
- }
+ "description" : "Sky is Clear",
+ "icon" : "01d",
+ "id" : 800.0,
+ "main" : "Clear"
+ },
+ "wind" : {
+ "deg" : 333.5,
+ "speed" : 3.43
}
}
-
+ }
Because the city resource is managed by Ambari and exposed through the REST API, it may be queried through the API like any other Ambari resource. All of the features of the API are available including partial response and query parameters. For example, we can request select weather attributes for the cities where the temperature is greater than 50 degrees...
- http://<server>:8080/api/v1/views/WEATHER/instances/?fields=cities/weather/main&cities/weather/main/temp>50
+ http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/?fields=cities/weather/main&cities/weather/main/temp%3E50
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/?fields=cities/weather/main&cities/weather/main/temp>50",
- "items" : [
{
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_CENTRAL",
- "ViewInstanceInfo" : {
- "instance_name" : "US_CENTRAL",
- "view_name" : "WEATHER"
- },
- "cities" : [
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_CENTRAL/cities/Dallas, US",
- "id" : "Dallas, US",
- "instance_name" : "US_CENTRAL",
- "view_name" : "WEATHER",
- "weather" : {
- "main" : {
- "humidity" : 50.0,
- "pressure" : 1015.0,
- "temp" : 64.29,
- "temp_max" : 64.99,
- "temp_min" : 64.0
- }
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/?fields=cities/weather/main&cities/weather/main/temp>50",
+ "items" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/EUROPE",
+ "ViewInstanceInfo" : {
+ "instance_name" : "EUROPE",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
+ },
+ "cities" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/EUROPE/cities/London, UK",
+ "id" : "London, UK",
+ "instance_name" : "EUROPE",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER",
+ "weather" : {
+ "main" : {
+ "grnd_level" : 1039.75,
+ "humidity" : 69.0,
+ "pressure" : 1039.75,
+ "sea_level" : 1049.87,
+ "temp" : 66.34,
+ "temp_max" : 66.34,
+ "temp_min" : 66.34
}
}
- ]
- },
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_MOUNTAIN",
- "ViewInstanceInfo" : {
- "instance_name" : "US_MOUNTAIN",
- "view_name" : "WEATHER"
},
- "cities" : [
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_MOUNTAIN/cities/Phoenix, US",
- "id" : "Phoenix, US",
- "instance_name" : "US_MOUNTAIN",
- "view_name" : "WEATHER",
- "weather" : {
- "main" : {
- "humidity" : 49.0,
- "pressure" : 1013.0,
- "temp" : 84.7,
- "temp_max" : 85.28,
- "temp_min" : 84.0
- }
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/EUROPE/cities/Paris",
+ "id" : "Paris",
+ "instance_name" : "EUROPE",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER",
+ "weather" : {
+ "main" : {
+ "grnd_level" : 1019.4,
+ "humidity" : 74.0,
+ "pressure" : 1019.4,
+ "sea_level" : 1036.29,
+ "temp" : 61.84,
+ "temp_max" : 61.84,
+ "temp_min" : 61.84
}
}
- ]
+ }
+ ]
+ },
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_CENTRAL",
+ "ViewInstanceInfo" : {
+ "instance_name" : "US_CENTRAL",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER"
},
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST",
- "ViewInstanceInfo" : {
- "instance_name" : "US_WEST",
- "view_name" : "WEATHER"
- },
- "cities" : [
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Los Angeles, US",
- "id" : "Los Angeles, US",
- "instance_name" : "US_WEST",
- "view_name" : "WEATHER",
- "weather" : {
- "main" : {
- "humidity" : 37.0,
- "pressure" : 1013.0,
- "temp" : 74.5,
- "temp_max" : 78.01,
- "temp_min" : 69.01
- }
- }
- },
- {
- "href" : "http://<server>:8080/api/v1/views/WEATHER/instances/US_WEST/cities/Palo Alto, US",
- "id" : "Palo Alto, US",
- "instance_name" : "US_WEST",
- "view_name" : "WEATHER",
- "weather" : {
- "main" : {
- "humidity" : 82.0,
- "pressure" : 969.0,
- "temp" : 59.2,
- "temp_max" : 62.01,
- "temp_min" : 55.99
- }
+ "cities" : [
+ {
+ "href" : "http://<server>:8080/api/v1/views/WEATHER/versions/1.0.0/instances/US_CENTRAL/cities/Dallas, US",
+ "id" : "Dallas, US",
+ "instance_name" : "US_CENTRAL",
+ "version" : "1.0.0",
+ "view_name" : "WEATHER",
+ "weather" : {
+ "main" : {
+ "grnd_level" : 1020.13,
+ "humidity" : 60.0,
+ "pressure" : 1020.13,
+ "sea_level" : 1037.18,
+ "temp" : 64.81,
+ "temp_max" : 64.81,
+ "temp_min" : 64.81
}
}
- ]
- }
- ]
- }
-
+ }
+ ]
+ },
+ ...
+ ]
+ }
If the view contains any web content, we can access it at the view's root context path. In this case its the WeatherServlet which displays a the weather for a set of cities based on the properties of the view instance.
- http://<server>:8080/views/WEATHER/US_WEST/ui
+ http://<server>:8080/views/WEATHER/1.0.0/US_WEST/ui
Selecting a specific city will show details about the weather in that city.
- http://<server>:8080/views/WEATHER/US_WEST/ui?city=Portland%2C+US
+ http://<server>:8080/views/WEATHER/1.0.0/US_WEST/ui?city=Palo+Alto%2C+US
-
+
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/weather-view/docs/paloalto.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/weather-view/docs/paloalto.png b/ambari-views/examples/weather-view/docs/paloalto.png
new file mode 100644
index 0000000..d983cef
Binary files /dev/null and b/ambari-views/examples/weather-view/docs/paloalto.png differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/weather-view/docs/portland.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/weather-view/docs/portland.png b/ambari-views/examples/weather-view/docs/portland.png
deleted file mode 100644
index 519b762..0000000
Binary files a/ambari-views/examples/weather-view/docs/portland.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/ambari/blob/742f5af6/ambari-views/examples/weather-view/docs/weather.png
----------------------------------------------------------------------
diff --git a/ambari-views/examples/weather-view/docs/weather.png b/ambari-views/examples/weather-view/docs/weather.png
index f382bf2..2339f42 100644
Binary files a/ambari-views/examples/weather-view/docs/weather.png and b/ambari-views/examples/weather-view/docs/weather.png differ