7eae8deacb
* my_tokens endpoint moved to normal index * remove secured_by from metacodes/users * ch ch ch changes * mess with template * fix securedBy * convenience open * gross authentication notes at the top of every endpoint * better ordering * move login tutorials into security tab * oauth tutorial * getting closer * remove unneeded Endpoints header * ok looks OK
233 lines
6.8 KiB
Plaintext
233 lines
6.8 KiB
Plaintext
<!DOCTYPE HTML>
|
|
<html>
|
|
<head>
|
|
<title>{{ title }} API documentation</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="generator" content="https://github.com/raml2html/raml2html {{ config.raml2HtmlVersion }}">
|
|
|
|
<link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/styles/default.min.css">
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script>
|
|
<script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
|
|
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/highlight.min.js"></script>
|
|
|
|
<script type="text/javascript">
|
|
$(document).ready(function() {
|
|
$('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
|
|
hljs.highlightBlock(block);
|
|
});
|
|
|
|
$('[data-toggle]').click(function() {
|
|
var selector = $(this).data('target') + ' pre code';
|
|
$(selector).each(function(i, block) {
|
|
hljs.highlightBlock(block);
|
|
});
|
|
});
|
|
|
|
// open modal on hashes like #_action_get
|
|
$(window).bind('hashchange', function(e) {
|
|
var anchor_id = document.location.hash.substr(1); //strip #
|
|
var element = $('#' + anchor_id);
|
|
|
|
// do we have such element + is it a modal? --> show it
|
|
if (element.length && element.hasClass('modal')) {
|
|
element.modal('show');
|
|
}
|
|
});
|
|
|
|
// execute hashchange on first page load
|
|
$(window).trigger('hashchange');
|
|
|
|
// remove url fragment on modal hide
|
|
$('.modal').on('hidden.bs.modal', function() {
|
|
try {
|
|
if (history && history.replaceState) {
|
|
history.replaceState({}, '', '#');
|
|
}
|
|
} catch(e) {}
|
|
});
|
|
});
|
|
</script>
|
|
|
|
<style>
|
|
.hljs {
|
|
background: transparent;
|
|
}
|
|
.parent {
|
|
color: #999;
|
|
}
|
|
.list-group-item > .badge {
|
|
float: none;
|
|
margin-right: 6px;
|
|
}
|
|
.panel-title > .methods {
|
|
float: right;
|
|
}
|
|
.badge {
|
|
border-radius: 0;
|
|
text-transform: uppercase;
|
|
width: 70px;
|
|
font-weight: normal;
|
|
color: #f3f3f6;
|
|
line-height: normal;
|
|
}
|
|
.badge_get {
|
|
background-color: #63a8e2;
|
|
}
|
|
.badge_post {
|
|
background-color: #6cbd7d;
|
|
}
|
|
.badge_put {
|
|
background-color: #22bac4;
|
|
}
|
|
.badge_delete {
|
|
background-color: #d26460;
|
|
}
|
|
.badge_patch {
|
|
background-color: #ccc444;
|
|
}
|
|
.list-group, .panel-group {
|
|
margin-bottom: 0;
|
|
}
|
|
.panel-group .panel+.panel-white {
|
|
margin-top: 0;
|
|
}
|
|
.panel-group .panel-white {
|
|
border-bottom: 1px solid #F5F5F5;
|
|
border-radius: 0;
|
|
}
|
|
.panel-white:last-child {
|
|
border-bottom-color: white;
|
|
-webkit-box-shadow: none;
|
|
box-shadow: none;
|
|
}
|
|
.panel-white .panel-heading {
|
|
background: white;
|
|
}
|
|
.tab-pane ul {
|
|
padding-left: 2em;
|
|
}
|
|
.tab-pane h1 {
|
|
font-size: 1.3em;
|
|
}
|
|
.tab-pane h2 {
|
|
font-size: 1.2em;
|
|
padding-bottom: 4px;
|
|
border-bottom: 1px solid #ddd;
|
|
}
|
|
.tab-pane h3 {
|
|
font-size: 1.1em;
|
|
}
|
|
.tab-content {
|
|
border-left: 1px solid #ddd;
|
|
border-right: 1px solid #ddd;
|
|
border-bottom: 1px solid #ddd;
|
|
padding: 10px;
|
|
}
|
|
#sidebar {
|
|
margin-top: 30px;
|
|
padding-right: 5px;
|
|
overflow: auto;
|
|
height: 90%;
|
|
}
|
|
.top-resource-description {
|
|
border-bottom: 1px solid #ddd;
|
|
background: #fcfcfc;
|
|
padding: 15px 15px 0 15px;
|
|
margin: -15px -15px 10px -15px;
|
|
}
|
|
.resource-description {
|
|
border-bottom: 1px solid #fcfcfc;
|
|
background: #fcfcfc;
|
|
padding: 15px 15px 0 15px;
|
|
margin: -15px -15px 10px -15px;
|
|
}
|
|
.resource-description p:last-child {
|
|
margin: 0;
|
|
}
|
|
.list-group .badge {
|
|
float: left;
|
|
}
|
|
.method_description {
|
|
margin-left: 85px;
|
|
}
|
|
.method_description p:last-child {
|
|
margin: 0;
|
|
}
|
|
.list-group-item {
|
|
cursor: pointer;
|
|
}
|
|
.list-group-item:hover {
|
|
background-color: #f5f5f5;
|
|
}
|
|
|
|
pre code {
|
|
overflow: auto;
|
|
word-wrap: normal;
|
|
white-space: pre;
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body data-spy="scroll" data-target="#sidebar">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-md-9" role="main">
|
|
<div class="page-header">
|
|
<h1>{{ title }} API documentation{% if version %} <small>version {{ version }}</small>{% endif %}</h1>
|
|
<p>{{ baseUri }}</p>
|
|
|
|
{% if baseUriParameters %}
|
|
<ul>
|
|
{% for item in baseUriParameters %}
|
|
{% include "./item.nunjucks" %}
|
|
{% endfor %}
|
|
</ul>
|
|
{% endif %}
|
|
</div>
|
|
|
|
{% for resource in resources %}
|
|
<div class="panel panel-default">
|
|
<div class="panel-heading">
|
|
<h3 id="{{ resource.uniqueId }}" class="panel-title">{% if resource.displayName %}{{ resource.displayName}}{% else %}{{ resource.relativeUri }}{% endif %}</h3>
|
|
</div>
|
|
|
|
<div class="panel-body">
|
|
{% if resource.description %}
|
|
<div class="top-resource-description">
|
|
{% markdown %}
|
|
{{ resource.description }}
|
|
{% endmarkdown %}
|
|
</div>
|
|
{% endif %}
|
|
|
|
<div class="panel-group">
|
|
{% include "./resource.nunjucks" %}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
{% endfor %}
|
|
|
|
{% for chapter in documentation %}
|
|
<h3 id="{{ chapter.uniqueId }}"><a href="#{{ chapter.uniqueId }}">{{ chapter.title }}</a></h3>
|
|
{% markdown %}
|
|
{{ chapter.content }}
|
|
{% endmarkdown %}
|
|
{% endfor %}
|
|
</div>
|
|
|
|
<div class="col-md-3">
|
|
<div id="sidebar" class="hidden-print affix" role="complementary">
|
|
<ul class="nav nav-pills nav-stacked">
|
|
{% for resource in resources %}
|
|
<li><a href="#{{ resource.uniqueId}}">{% if resource.displayName %}{{ resource.displayName}}{% else %}{{ resource.relativeUri }}{% endif %}</a></li>
|
|
{% endfor %}
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|