-
Notifications
You must be signed in to change notification settings - Fork 0
/
vdb-builder-rest.html
282 lines (276 loc) · 20.3 KB
/
vdb-builder-rest.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<!DOCTYPE HTML><html><head><title>vdb-builder API 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/kevinrenskers/raml2html 1.6.0"><link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"><link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css"><script type="text/javascript" src="http://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script><script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script><script type="text/javascript">
$(document).ready(function() {
$('.page-header pre code, .top-resource-description 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() {
if(history && history.replaceState) {
history.replaceState({}, '', '#');
}
});
});
</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 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;
}
</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>vdb-builder API API documentation <small>version v1</small></h1><p>http://localhost:8080/vdb-bench/api/v1</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_vdbs" class="panel-title">/vdbs</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__vdbs"><span class="parent"></span>/vdbs</a> <span class="methods"><a href="#_vdbs_get"><span class="badge badge_get">get</span></a> <a href="#_vdbs_put"><span class="badge badge_put">put</span></a> <a href="#_vdbs_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__vdbs" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_vdbs_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List available vdbs</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_vdbs_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_vdbs_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdbs_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/vdbs</h4></div><div class="modal-body"><div class="alert alert-info"><p>List available vdbs</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_vdbs_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_vdbs_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"vdbs": [
{
"id": "portfolio",
"_links": [
{
"rel": "self",
"href": "/vdbs/portfolio"
},
{
"rel": "content",
"href": "/vdb/portfolio"
}
]
},
{
"id": "tweet-example",
"_links": [
{
"rel": "self",
"href": "/vdbs/tweet-example"
},
{
"rel": "content",
"href": "/vdb/tweet-example"
}
]
},
{
"id": "parts",
"_links": [
{
"rel": "self",
"href": "/vdbs/parts"
},
{
"rel": "content",
"href": "/vdb/parts"
}
]
}
]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdbs_put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent"></span>/vdbs</h4></div><div class="modal-body"><ul class="nav nav-tabs"></ul><div class="tab-content"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdbs_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/vdbs</h4></div><div class="modal-body"><ul class="nav nav-tabs"></ul><div class="tab-content"></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__vdbs__vdbId_"><span class="parent">/vdbs</span>/{vdbId}</a> <span class="methods"><a href="#_vdbs__vdbId__get"><span class="badge badge_get">get</span></a> <a href="#_vdbs__vdbId__put"><span class="badge badge_put">put</span></a> <a href="#_vdbs__vdbId__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel__vdbs__vdbId_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_vdbs__vdbId__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve the meta data for the given vdb</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_vdbs__vdbId__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_vdbs__vdbId__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdbs__vdbId__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/vdbs</span>/{vdbId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve the meta data for the given vdb</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_vdbs__vdbId__get_request" data-toggle="tab">Request</a></li><li><a href="#_vdbs__vdbId__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_vdbs__vdbId__get_request"><h3>URI Parameters</h3><ul><li><strong>vdbId</strong>: <em>required (string )</em></li></ul><h3>Headers</h3><ul><li><strong>Accept</strong>: <em>required (one of application/json,application/xml )</em></li></ul></div><div class="tab-pane" id="_vdbs__vdbId__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"vdbs": [
{
"id": "portfolio",
"_links": [
{
"rel": "self",
"href": "/vdbs/portfolio"
},
{
"rel": "content",
"href": "/vdb/portfolio"
}
]
},
{
"id": "tweet-example",
"_links": [
{
"rel": "self",
"href": "/vdbs/tweet-example"
},
{
"rel": "content",
"href": "/vdb/tweet-example"
}
]
},
{
"id": "parts",
"_links": [
{
"rel": "self",
"href": "/vdbs/parts"
},
{
"rel": "content",
"href": "/vdb/parts"
}
]
}
]
}
</code></pre><p><strong>Type: application/xml</strong></p><p><strong>Example</strong>:</p><pre><code><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vdbs>
<vdb id="portfolio">
<links>
<link rel="self" href="/vdbs/portfolio"></link>
<link rel="content" href="/vdb/portfolio"></link>
</links>
</vdb>
<vdb id="tweet-example">
<links>
<link rel="self" href="/vdbs/tweet-example"></link>
<link rel="content" href="/vdb/tweet-example"></link>
</links>
</vdb>
<vdb id="parts">
<links>
<link rel="self" href="/vdbs/parts"></link>
<link rel="content" href="/vdb/parts"></link>
</links>
</vdb>
</vdbs></code></pre><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>No vdb named portfolio</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdbs__vdbId__put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/vdbs</span>/{vdbId}</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_vdbs__vdbId__put_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_vdbs__vdbId__put_request"><h3>URI Parameters</h3><ul><li><strong>vdbId</strong>: <em>required (string )</em></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdbs__vdbId__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/vdbs</span>/{vdbId}</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_vdbs__vdbId__delete_request" data-toggle="tab">Request</a></li><li><a href="#_vdbs__vdbId__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_vdbs__vdbId__delete_request"><h3>URI Parameters</h3><ul><li><strong>vdbId</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_vdbs__vdbId__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>No vdb named portfolio</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_vdb" class="panel-title">/vdb</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__vdb__vdbId_"><span class="parent">/vdb</span>/{vdbId}</a> <span class="methods"><a href="#_vdb__vdbId__get"><span class="badge badge_get">get</span></a> <a href="#_vdb__vdbId__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__vdb__vdbId_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_vdb__vdbId__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve the content for the given vdb</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_vdb__vdbId__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdb__vdbId__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/vdb</span>/{vdbId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve the content for the given vdb</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_vdb__vdbId__get_request" data-toggle="tab">Request</a></li><li><a href="#_vdb__vdbId__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_vdb__vdbId__get_request"><h3>URI Parameters</h3><ul><li><strong>vdbId</strong>: <em>required (string )</em></li></ul><h3>Headers</h3><ul><li><strong>Accept</strong>: <em>required (one of application/json,application/xml )</em></li></ul></div><div class="tab-pane" id="_vdb__vdbId__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"vdb": [
{
"id": "portfolio",
"name": "Portfolio",
"version": 1,
"description": "The Portfolio Dynamic VDB"
},
{
"id": "tweet-example",
"name": "Tweet Example",
"version": 1,
"description": "The Tweet Example VDB"
},
{
"id": "parts",
"name": "Parts",
"version": 1,
"description": "The Parts VDB"
}
]
}</code></pre><p><strong>Type: application/xml</strong></p><p><strong>Example</strong>:</p><pre><code><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vdb-contents>
<vdb id="portfolio" name="Portfolio" version="1">
<description>The Portfolio Dynamic VDB</description>
</vdb>
<vdb id="tweet-example" name="Tweet Example" version="1">
<description>The Tweet Example VDB</description>
</vdb>
<vdb id="parts" name="Parts" version="1">
<description>The Parts VDB</description>
</vdb>
</vdb-contents></code></pre><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>No vdb named portfolio</code></pre><p><strong>Type: application/xml</strong></p><p><strong>Example</strong>:</p><pre><code>No vdb content for vdb named portfolio</code></pre><h2>HTTP status code <a href="http://httpstatus.es/406" target="_blank">406</a></h2><p>Request has invalid Accept header</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_vdb__vdbId__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/vdb</span>/{vdbId}</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_vdb__vdbId__post_request" data-toggle="tab">Request</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_vdb__vdbId__post_request"><h3>URI Parameters</h3><ul><li><strong>vdbId</strong>: <em>required (string )</em></li></ul></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="#_vdbs">/vdbs</a></li><li><a href="#_vdb">/vdb</a></li></ul></div></div></div></div></body></html>