mirror of
https://github.com/Decicus/DecAPI-Docs.git
synced 2024-11-25 22:02:32 +01:00
121 lines
5.8 KiB
HTML
121 lines
5.8 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<title>DecAPI Docs</title>
|
||
|
|
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin="anonymous">
|
||
|
|
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<nav class="navbar navbar-default" role="navigation">
|
||
|
|
<div class="container-fluid">
|
||
|
|
<div class="navbar-header">
|
||
|
|
<a class="navbar-brand" href="#">DecAPI Docs</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<ul class="nav navbar-nav">
|
||
|
|
<li><a href="https://github.com/Decicus/DecAPI"><i class="fa fa-1x fa-github"></i> GitHub Repo</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div class="container-fluid" id="content">
|
||
|
|
<i class="hidden fa fa-1x" id="fa-template"></i>
|
||
|
|
|
||
|
|
<div class="hidden" id="base-template">
|
||
|
|
<div class="page-header">
|
||
|
|
<h4><i class="fa fa-1x fa-fw"></i> <span></span></h4>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="panel panel-default hidden" id="endpoint-template">
|
||
|
|
<div class="panel-heading">
|
||
|
|
<h3 class="panel-title" id="title">
|
||
|
|
<span class="text-muted" id="base"><a href="#"></a></span><span id="route"></span>
|
||
|
|
</h3>
|
||
|
|
</div>
|
||
|
|
<div class="panel-body" id="main-body">
|
||
|
|
<p class="text-warning">Notes:</p>
|
||
|
|
<ul id="description" class="list-group text-primary"></ul>
|
||
|
|
<pre><strong class="text-primary"></strong> <code></code></pre>
|
||
|
|
|
||
|
|
<div id="routes" class="hidden">
|
||
|
|
<p class="text-warning">Route parameters:</p>
|
||
|
|
|
||
|
|
<table class="table table-bordered" id="route-body">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Parameter name:</th>
|
||
|
|
<th>Description:</th>
|
||
|
|
<th>Required:</th>
|
||
|
|
<th>Type:</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody></tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="qs" class="hidden">
|
||
|
|
<p class="text-warning">Query string parameters:</p>
|
||
|
|
|
||
|
|
<table class="table table-bordered" id="qs-body">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Parameter name:</th>
|
||
|
|
<th>Description:</th>
|
||
|
|
<th>Required:</th>
|
||
|
|
<th>Type:</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody></tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="page-header">
|
||
|
|
<h1>DecAPI Docs</h1>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="panel panel-primary">
|
||
|
|
<div class="panel-heading">
|
||
|
|
<h3 class="panel-title">General information</h3>
|
||
|
|
</div>
|
||
|
|
<div class="panel-body">
|
||
|
|
These pages will house the documentation of endpoints under DecAPI.
|
||
|
|
<br>
|
||
|
|
Each page of documentation will contain a list of endpoints as well as some information regarding each of them.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="panel panel-primary">
|
||
|
|
<div class="panel-heading">
|
||
|
|
<h3 class="panel-title">Default options & results</h3>
|
||
|
|
</div>
|
||
|
|
<div class="panel-body">
|
||
|
|
<p>These are options or results that will be the default, <strong>unless the notes about the endpoint mention otherwise</strong>.</p>
|
||
|
|
<div class="list-group">
|
||
|
|
<li class="list-group-item">The base URL for all endpoints is <code>https://beta.decapi.me</code> and requires support for SSL.</li>
|
||
|
|
<li class="list-group-item"><strong>HTTP</strong> requests will receive a <code>301 Moved Permanently</code> to <strong>HTTPS</strong>.</li>
|
||
|
|
<li class="list-group-item">The default HTTP method supported is <code>GET</code>.</li>
|
||
|
|
<li class="list-group-item">Responses are <code>Content-Type: text/plain</code>.</li>
|
||
|
|
<li class="list-group-item">Parameters are <strong>always</strong> required.</li>
|
||
|
|
<li class="list-group-item">Query strings are <strong>never</strong> required.</li>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="page-header">
|
||
|
|
<h1>Endpoints:</h1>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js" integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" crossorigin="anonymous"></script>
|
||
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
|
||
|
|
<script src="./js/main.js" charset="utf-8"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|