Bug-915: Adding static document generation.
[controller.git] / opendaylight / md-sal / sal-rest-docgen / src / main / resources / explorer / index.html
1 <!DOCTYPE html>\r
2 <html>\r
3 <head>\r
4 <title>RestConf Documentation</title>\r
5 <link href='//fonts.googleapis.com/css?family=Droid+Sans:400,700'\r
6         rel='stylesheet' type='text/css' />\r
7 <link href='css/highlight.default.css' media='screen' rel='stylesheet'\r
8         type='text/css' />\r
9 <link href='css/screen.css' media='screen' rel='stylesheet'\r
10         type='text/css' />\r
11 <link rel="stylesheet" type="text/css" href="/css/opendaylight.css">\r
12 <link rel="stylesheet" type="text/css"\r
13         href="css/ui-lightness/jquery-ui-1.10.4.custom.min.css">\r
14 <script type="text/javascript" src="lib/shred.bundle.js"></script>\r
15 <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>\r
16 <script src='lib/jquery-ui-1.11.0.min.js' type="text/javascript"></script>\r
17 <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>\r
18 <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>\r
19 <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>\r
20 <script src='lib/handlebars-1.0.0.js' type='text/javascript'></script>\r
21 <script src='lib/underscore-min.js' type='text/javascript'></script>\r
22 <script src='lib/backbone-min.js' type='text/javascript'></script>\r
23 <script src='lib/swagger.js' type='text/javascript'></script>\r
24 <script src='swagger-ui.js' type='text/javascript'></script>\r
25 <script src='lib/odl/list_mounts.js' type='text/javascript'></script>\r
26 <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>\r
27 <script src='lib/odl/swagger.js' type='text/javascript'></script>\r
28 \r
29 <script type="text/javascript">\r
30         \r
31         //reloads the swagger UI documentation for the specified mount.\r
32         var loadMount = function(mountIndex, mountPath) {\r
33                 $("#message").empty();\r
34                 $("#message").append( "<p>Loading...</p>" );\r
35                 loadSwagger("/apidoc/apis/mounts/" + mountIndex,\r
36                                 "swagger-ui-container");\r
37                 $("#message").empty();\r
38                 $("#message").append( "<h2><b>Showing mount points for " + mountPath + "</b></h2>");\r
39         }\r
40 \r
41         //clears the swagger UI and adds text prompting use to select a mount point.\r
42     var selectAMount = function(string) {\r
43         $("#swagger-ui-container").empty();\r
44         $("#message").empty();\r
45         $("#message").append("<p>Select a mount point.</p>");\r
46     }\r
47     \r
48         //loads the root swagger documenation (which comes from RestConf)\r
49         var loadRootSwagger = function() {\r
50                 $("#message").empty();\r
51                 loadSwagger("/apidoc/apis", "swagger-ui-container");\r
52         }\r
53 \r
54         //main method to initialize the mount list / swagger docs / tabs on page load\r
55         $(function() {\r
56                 $("#tabs").tabs();\r
57 \r
58                 loadMountList($("#mountlist"));\r
59 \r
60                 loadRootSwagger();\r
61         });\r
62 </script>\r
63 </head>\r
64 \r
65 <body>\r
66         <div>\r
67                 <!-- style="background-color: #FCA000;" -->\r
68                 <div class="swagger-ui-wrap ui-tabs">\r
69                         <table>\r
70                                 <tr>\r
71                                         <td><img src="images/logo_small.png" /></td>\r
72                                         <td><h1 width="100%">OpenDaylight RestConf API\r
73                                                         Documentation</h1></td>\r
74                                 </tr>\r
75                         </table>\r
76                 </div>\r
77         </div>\r
78 \r
79         <div class="navbar-inner">\r
80                 <div class="brand"></div>\r
81         </div>\r
82 \r
83     <!--  defines the div shells which represent the jquery tabs -->\r
84         <div id="tabs" class="swagger-ui-wrap">\r
85                 <ul>\r
86                         <li><a href="#Controller" onclick="loadRootSwagger()">Controller\r
87                                         Resources</a></li>\r
88                         <li><a href="#Mounts" onclick="selectAMount()">Mounted\r
89                                         Resources</a></li>\r
90                 </ul>\r
91 \r
92                 <div id="Controller">\r
93                         <div>\r
94                                 <h3>Below are the list of APIs supported by the Controller.</h3>\r
95                         </div>\r
96                 </div>\r
97                 <div id="Mounts">\r
98                         <div>\r
99                                 <h3>Mount Points - Select an API below for details on available\r
100                                         queries.</h3>\r
101                         </div>\r
102                         <div id="mountlist"></div>\r
103                 </div>\r
104         </div>\r
105         \r
106         <div class="swagger-ui-wrap"><hr/></div>\r
107         \r
108         <!-- messages -->\r
109         <div id="message" class="swagger-ui-wrap"></div>\r
110         \r
111         <!-- the swagger is always loaded in this div -->\r
112         <div id="swagger-ui-container" class="swagger-ui-wrap"></div>\r
113 \r
114         <div id="message-bar" class="swagger-ui-wrap">&nbsp;</div>\r
115 </body>\r
116 \r
117 </html>\r