Skip to content

Instantly share code, notes, and snippets.

@zaibon

zaibon/ds.html

Created May 23, 2017 14:28
Show Gist options
  • Save zaibon/95221d91f7bf063b357604a1b9992520 to your computer and use it in GitHub Desktop.
Save zaibon/95221d91f7bf063b357604a1b9992520 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
ds.html
<!DOCTYPE HTML><html><head><title>Directory service 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 5.0.0"><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;
}
.items {
background: #f5f5f5;
color: #333;
border: 1px solid #ccc;
border-radius: 4px;
padding: 9.5px;
margin: 0 0 10px;
font-size: 13px;
line-height: 1.42857143;
}
.examples {
margin-left: 0.5em;
}
.resource-modal li > ul {
margin-bottom: 1em;
}
</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>Directory service API documentation <small>version 0.0.1</small></h1><p>https://discovery.gig.tech</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="services" class="panel-title">/services</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_services"><span class="parent"></span>/services</a> <span class="methods"><a href="#services_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#services_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_services" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#services_post'" class="list-group-item"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Register a new service to the directory</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#services_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List all services</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="services_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/services</h4></div><div class="modal-body"><div class="alert alert-info"><p>Register a new service to the directory</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>itsyouonline</b> with scopes:<ul><li>user:name</li></ul></div><ul class="nav nav-tabs"><li class="active"><a href="#services_post_request" data-toggle="tab">Request</a></li><li><a href="#services_post_response" data-toggle="tab">Response</a></li><li><a href="#services_post_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="services_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>Name</strong>: <em>required (string - pattern: ^\w+$)</em></li><li><strong>apiURL</strong>: <em>required (string)</em><p>Base URL of the service API. This is trhough this API that the client of the service will communicate with the service</p></li><li><strong>reservationSchemes</strong>: <em>required (array of ReservationScheme)</em><p>Describe the possible resevation that can be made for this service</p><p><strong>Items</strong>: ReservationScheme</p><div class="items"><ul><li><strong>unit</strong>: <em>required (one of storage, network, compute, transaction)</em></li><li><strong>minDuration</strong>: <em>required (integer)</em><p>Minimal duration of the reservation in days</p></li><li><strong>price</strong>: <em>required (number)</em><p>Price per unit</p></li><li><strong>earlyTerminationFee</strong>: <em>required (number)</em><p>Amount of the fee in case of termination of the reservation before expiration</p></li></ul></div></li></ul></div><div class="tab-pane" id="services_post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>service created</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: ServiceCreate</p><strong>Properties</strong><ul><li><strong>id</strong>: <em>required (string)</em><p>Unique identifier for the service</p></li><li><strong>created</strong>: <em>required (datetime)</em><p>Date of creation of the service</p></li><li><strong>quality</strong>: <em>required (object)</em><p>Information about the quality of the service</p><ul><li><strong>uptime</strong>: <em>required (integer)</em><p>Uptime of the service in percent</p></li><li><strong>downPeriods</strong>: <em>required (array of items)</em><p>Last time the service was down</p><p><strong>Items</strong>: items</p><div class="items"><ul><li><strong>begin</strong>: <em>required (datetime)</em></li><li><strong>duration</strong>: <em>required (integer)</em><p>duration of the downtime in minute</p></li></ul></div></li><li><strong>averageRestaurationTime</strong>: <em>required (integer)</em><p>Average number of minute before the service come back up after a problem occurs.</p></li></ul></li></ul><h2>HTTP status code <a href="http://httpstatus.es/409" target="_blank">409</a></h2><p>conflict, a service with this id already exists</p></div><div class="tab-pane" id="services_post_securedby"><h1>Secured by [object Object]</h1></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="services_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/services</h4></div><div class="modal-body"><div class="alert alert-info"><p>List all services</p></div><ul class="nav nav-tabs"><li class="active"><a href="#services_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="services_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of ServiceCreate</p><p><strong>Items</strong>: ServiceCreate</p><div class="items"><ul><li><strong>Name</strong>: <em>required (string - pattern: ^\w+$)</em></li><li><strong>apiURL</strong>: <em>required (string)</em><p>Base URL of the service API. This is trhough this API that the client of the service will communicate with the service</p></li><li><strong>reservationSchemes</strong>: <em>required (array of ReservationScheme)</em><p>Describe the possible resevation that can be made for this service</p><p><strong>Items</strong>: ReservationScheme</p><div class="items"><ul><li><strong>unit</strong>: <em>required (one of storage, network, compute, transaction)</em></li><li><strong>minDuration</strong>: <em>required (integer)</em><p>Minimal duration of the reservation in days</p></li><li><strong>price</strong>: <em>required (number)</em><p>Price per unit</p></li><li><strong>earlyTerminationFee</strong>: <em>required (number)</em><p>Amount of the fee in case of termination of the reservation before expiration</p></li></ul></div></li></ul></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_services__serviceid_"><span class="parent">/services</span>/{serviceid}</a> <span class="methods"><a href="#services__serviceid__put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#services__serviceid__delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#services__serviceid__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_services__serviceid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#services__serviceid__put'" class="list-group-item"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Update service</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#services__serviceid__delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete service</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#services__serviceid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Get detail view about service</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="services__serviceid__put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/services</span>/{serviceid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update service</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>itsyouonline</b> with scopes:<ul><li>user:name</li></ul></div><ul class="nav nav-tabs"><li class="active"><a href="#services__serviceid__put_request" data-toggle="tab">Request</a></li><li><a href="#services__serviceid__put_response" data-toggle="tab">Response</a></li><li><a href="#services__serviceid__put_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="services__serviceid__put_request"><h3>URI Parameters</h3><ul><li><strong>serviceid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="services__serviceid__put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>Name</strong>: <em>required (string - pattern: ^\w+$)</em></li><li><strong>apiURL</strong>: <em>required (string)</em><p>Base URL of the service API. This is trhough this API that the client of the service will communicate with the service</p></li><li><strong>reservationSchemes</strong>: <em>required (array of ReservationScheme)</em><p>Describe the possible resevation that can be made for this service</p><p><strong>Items</strong>: ReservationScheme</p><div class="items"><ul><li><strong>unit</strong>: <em>required (one of storage, network, compute, transaction)</em></li><li><strong>minDuration</strong>: <em>required (integer)</em><p>Minimal duration of the reservation in days</p></li><li><strong>price</strong>: <em>required (number)</em><p>Price per unit</p></li><li><strong>earlyTerminationFee</strong>: <em>required (number)</em><p>Amount of the fee in case of termination of the reservation before expiration</p></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>service not found</p></div><div class="tab-pane" id="services__serviceid__put_securedby"><h1>Secured by [object Object]</h1></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="services__serviceid__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/services</span>/{serviceid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete service</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>itsyouonline</b> with scopes:<ul><li>user:name</li></ul></div><ul class="nav nav-tabs"><li class="active"><a href="#services__serviceid__delete_request" data-toggle="tab">Request</a></li><li><a href="#services__serviceid__delete_response" data-toggle="tab">Response</a></li><li><a href="#services__serviceid__delete_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="services__serviceid__delete_request"><h3>URI Parameters</h3><ul><li><strong>serviceid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="services__serviceid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2><p>service deleted successfully</p><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>service not found</p></div><div class="tab-pane" id="services__serviceid__delete_securedby"><h1>Secured by [object Object]</h1></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="services__serviceid__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/services</span>/{serviceid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get detail view about service</p></div><ul class="nav nav-tabs"><li class="active"><a href="#services__serviceid__get_request" data-toggle="tab">Request</a></li><li><a href="#services__serviceid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="services__serviceid__get_request"><h3>URI Parameters</h3><ul><li><strong>serviceid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="services__serviceid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>Name</strong>: <em>required (string - pattern: ^\w+$)</em></li><li><strong>apiURL</strong>: <em>required (string)</em><p>Base URL of the service API. This is trhough this API that the client of the service will communicate with the service</p></li><li><strong>reservationSchemes</strong>: <em>required (array of ReservationScheme)</em><p>Describe the possible resevation that can be made for this service</p><p><strong>Items</strong>: ReservationScheme</p><div class="items"><ul><li><strong>unit</strong>: <em>required (one of storage, network, compute, transaction)</em></li><li><strong>minDuration</strong>: <em>required (integer)</em><p>Minimal duration of the reservation in days</p></li><li><strong>price</strong>: <em>required (number)</em><p>Price per unit</p></li><li><strong>earlyTerminationFee</strong>: <em>required (number)</em><p>Amount of the fee in case of termination of the reservation before expiration</p></li></ul></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><p>service not found</p></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#services">/services</a></li></ul></div></div></div></div></body></html>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment