Gitiles
Code Review Sign In
gerrit.onosproject.org / onos / 0409b709b3c09a833861869d446eec5e1617bb4a / . / web / api / src / main / resources / docs / index.html
blob: 20f0c7edc5c43c7524633496646b6472c4ad3d26 [file] [log] [blame]
Thomas Vachuska0fa2aa12015-08-18 12:53:04 -0700[diff] [blame]1<!-- Adapted from Swagger UI -->
2<!DOCTYPE html>
3<html>
4<head>
5 <title>ONOS API Docs</title>
6 <link rel="icon" type="image/png" href="images/onos-logo.png"/>
7
8 <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
9 <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
10 <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
11 <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>
12 <link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>
13 <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>
14 <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>
15 <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>
16 <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
17 <script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>
18 <script src='lib/underscore-min.js' type='text/javascript'></script>
19 <script src='lib/backbone-min.js' type='text/javascript'></script>
20 <script src='swagger-ui.js' type='text/javascript'></script>
21 <script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>
22 <script src='lib/marked.js' type='text/javascript'></script>
23 <script src='lib/swagger-oauth.js' type='text/javascript'></script>
Jian Li83d87a72016-04-20 15:38:24 -0700[diff] [blame]24 <script src='lib/jsoneditor.min.js' type='text/javascript'></script>
Thomas Vachuska0fa2aa12015-08-18 12:53:04 -0700[diff] [blame]25
26 <script type="text/javascript">
27 $(function () {
28 var url = window.location.search.match(/url=([^&]+)/);
29 if (url && url.length > 1) {
30 url = decodeURIComponent(url[1]);
31 } else {
32 url = "/onos/v1/docs/apis/onos/v1/swagger.json";
33 }
34 window.swaggerUi = new SwaggerUi({
35 url: url,
Jonathan Hart345c0192016-04-20 09:00:58 -0700[diff] [blame]36 validatorUrl : null,
Thomas Vachuska0fa2aa12015-08-18 12:53:04 -0700[diff] [blame]37 dom_id: "swagger-ui-container",
38 supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
39 onComplete: function(swaggerApi, swaggerUi){
40 if(typeof initOAuth == "function") {
41 initOAuth({
42 clientId: "your-client-id",
43 realm: "your-realms",
44 appName: "your-app-name"
45 });
46 }
47
48 $('pre code').each(function(i, e) {
49 hljs.highlightBlock(e)
50 });
51
52 addApiKeyAuthorization();
53 },
54 onFailure: function(data) {
55 log("Unable to Load SwaggerUI");
56 },
57 docExpansion: "none",
58 apisSorter: "alpha",
59 showRequestHeaders: false
60 });
61
62 function addApiKeyAuthorization(){
63 var key = encodeURIComponent($('#input_apiKey')[0].value);
64 if(key && key.trim() != "") {
65 var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
66 window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
67 log("added key " + key);
68 }
69 }
70
71 $('#input_apiKey').change(addApiKeyAuthorization);
72
73 // if you have an apiKey you would like to pre-populate on the page for demonstration purposes...
74 /*
75 var apiKey = "myApiKeyXXXX123456789";
76 $('#input_apiKey').val(apiKey);
77 */
78
79 window.swaggerUi.load();
80
81 function log() {
82 if ('console' in window) {
83 console.log.apply(console, arguments);
84 }
85 }
86 });
87
88 function selectApi() {
89 $('#input_baseUrl').val('/onos/v1/docs/apis' + $('select').val() + '/swagger.json');
90 $('#explore').click();
91 }
92 </script>
93</head>
94
95<body class="swagger-section">
96<div id='header'>
97 <div class="swagger-ui-wrap">
98 <a id="logo" href="#"></a>
99 <form id='api_selector'>
100 <div class='input' id='selector'>
101 <select onchange="selectApi()">
102 <!-- {API-START} -->
103 <option value="v1">ONOS v1 Core</option>
104 <option value="foo">ONOS Foo app</option>
105 <option value="bar">ONOS Bar app</option>
106 <!-- {API-END} -->
107 </select>
108 </div>
109 <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
110 <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
111 <div class='input'><a id="explore" href="#">Explore</a></div>
112 </form>
113 </div>
114</div>
115
116<div id="message-bar" class="swagger-ui-wrap">&nbsp;</div>
117<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
118<div id="footer" class="swagger-ui-wrap"><a href="http://swagger.io/swagger-ui/">Swagger UI</a> adaptation</div>
119</body>
120</html>