diff options
| author | Kegan Dougal <kegan@matrix.org> | 2014-09-01 14:11:26 +0100 |
|---|---|---|
| committer | Kegan Dougal <kegan@matrix.org> | 2014-09-01 14:11:26 +0100 |
| commit | 389ee3624ce1c257fbbff20e620c9da39ea123a0 (patch) | |
| tree | 60383f67c02287c2cb39663012e116cd66ac4e1c /docs/client-server/web/swagger.html | |
| parent | Renamed json files because: paths. (diff) | |
| download | synapse-389ee3624ce1c257fbbff20e620c9da39ea123a0.tar.xz | |
Added /web folder which contains html/css (based off the default swagger-ui) for viewing the c-s json api.
Diffstat (limited to '')
| -rw-r--r-- | docs/client-server/web/swagger.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/client-server/web/swagger.html b/docs/client-server/web/swagger.html new file mode 100644 index 0000000000..c4ee64270a --- /dev/null +++ b/docs/client-server/web/swagger.html @@ -0,0 +1,78 @@ +<!DOCTYPE html> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Matrix Client-Server API Documentation</title> + <link href="./files/css" rel="stylesheet" type="text/css"> + <link href="./files/reset.css" media="screen" rel="stylesheet" type="text/css"> + <link href="./files/screen.css" media="screen" rel="stylesheet" type="text/css"> + <link href="./files/reset.css" media="print" rel="stylesheet" type="text/css"> + <link href="./files/screen.css" media="print" rel="stylesheet" type="text/css"> + <script type="text/javascript" src="./files/shred.bundle.js"></script> + <script src="./files/jquery-1.8.0.min.js" type="text/javascript"></script> + <script src="./files/jquery.slideto.min.js" type="text/javascript"></script> + <script src="./files/jquery.wiggle.min.js" type="text/javascript"></script> + <script src="./files/jquery.ba-bbq.min.js" type="text/javascript"></script> + <script src="./files/handlebars-1.0.0.js" type="text/javascript"></script> + <script src="./files/underscore-min.js" type="text/javascript"></script> + <script src="./files/backbone-min.js" type="text/javascript"></script> + <script src="./files/swagger.js" type="text/javascript"></script> + <script src="./files/swagger-ui.js" type="text/javascript"></script> + <script src="./files/highlight.7.3.pack.js" type="text/javascript"></script> + + <!-- enabling this will enable oauth2 implicit scope support --> + <script src="./files/swagger-oauth.js" type="text/javascript"></script> + + <script type="text/javascript"> + $(function () { + window.swaggerUi = new SwaggerUi({ + url: "http://localhost:8000/swagger_matrix/api-docs", + dom_id: "swagger-ui-container", + supportedSubmitMethods: ['get', 'post', 'put', 'delete'], + onComplete: function(swaggerApi, swaggerUi){ + log("Loaded SwaggerUI"); + + if(typeof initOAuth == "function") { + initOAuth({ + clientId: "your-client-id", + realm: "your-realms", + appName: "your-app-name" + }); + } + $('pre code').each(function(i, e) { + hljs.highlightBlock(e) + }); + }, + onFailure: function(data) { + log("Unable to Load SwaggerUI"); + }, + docExpansion: "none" + }); + + $('#input_apiKey').change(function() { + var key = $('#input_apiKey')[0].value; + log("key: " + key); + if(key && key.trim() != "") { + log("added key " + key); + window.authorizations.add("key", new ApiKeyAuthorization("access_token", key, "query")); + } + }) + window.swaggerUi.load(); + }); + </script> +</head> + +<body class="swagger-section"> +<div id="header"> + <div class="swagger-ui-wrap"> + <a id="logo" href="http://swagger.wordnik.com/">swagger</a> + <form id="api_selector"> + <div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div> + <div class="input"><input placeholder="access_token" id="input_apiKey" name="apiKey" type="text"></div> + </form> + </div> +</div> + +<div id="message-bar" class="swagger-ui-wrap message-fail">Can't read from server. It may not have the appropriate access-control-origin settings.</div> +<div id="swagger-ui-container" class="swagger-ui-wrap"></div> + + +</body></html> |