/
world-music-api.html
205 lines (200 loc) · 23.3 KB
/
world-music-api.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
<!DOCTYPE HTML><html><head><title>World Music 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/raml2html/raml2html 4.0.1"><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;
}
</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>World Music API API documentation <small>version v1</small></h1><p>http://{environment}.musicapi.com/{version}</p><ul><li><strong>environment</strong>: <em>required (one of stg, dev, test, prod)</em></li><li><strong>version</strong>: <em>required (v1)</em></li></ul><h3 id="getting_started"><a href="#getting_started">Getting Started</a></h3><p>This is a getting started guide for the World Music API.</p><h3 id="legal"><a href="#legal">Legal</a></h3><p>See <a href="http://legal.musicapi.com">http://legal.musicapi.com</a></p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="api" class="panel-title">/api</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_api"><span class="parent"></span>/api</a> <span class="methods"><a href="#api_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#api_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_api" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#api_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"></div><div class="clearfix"></div></div><div onclick="window.location.href = '#api_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"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_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 class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/api</h4></div><div class="modal-body"><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_get_request" data-toggle="tab">Request</a></li><li><a href="#api_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_get_request"><h3>Query String</h3><ul><li><strong>start</strong>: <em>(number)</em></li><li><strong>page-size</strong>: <em>(number)</em></li></ul></div><div class="tab-pane" id="api_get_securedby"><h1>Secured by custom_scheme</h1><h3>Headers</h3><ul><li><strong>SpecialToken</strong>: <em>required (string)</em><p>Used to send a custom token.</p></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="api_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 class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/api</h4></div><div class="modal-body"><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#api_post_request" data-toggle="tab">Request</a></li><li><a href="#api_post_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="api_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>propString</strong>: <em>required (string)</em></li><li><strong>propStringArray1</strong>: <em>required (array of string)</em></li><li><strong>ideas</strong>: <em>required (array of items)</em><p><strong>Items</strong>: items</p><ul class="items"><li><strong>comment</strong>: <em>required (string)</em></li></ul></li><li><strong>extIdeas</strong>: <em>required ([object Object])</em><ul><li><strong>createdBy</strong>: <em>required (string)</em></li></ul></li><li><strong>feedback</strong>: <em>required (string - default: very nice - minLength: 1 - maxLength: 255 - pattern: [a-zA-Z\s]*)</em><p><strong>Examples</strong>:</p><pre>very well made</pre></li><li><strong>propNumber</strong>: <em>required (number - minimum: 0 - maximum: 32)</em></li><li><strong>propInteger</strong>: <em>required (integer - minimum: 3 - maximum: 5)</em></li><li><strong>propBoolean</strong>: <em>required (boolean)</em></li><li><strong>propDate</strong>: <em>required (date-only)</em><p><strong>Examples</strong>:</p><pre><code>2015-05-23</code></pre></li><li><strong>userPicture</strong>: <em>required (file)</em></li><li><strong>NilValue</strong>: <em>required (object)</em><ul><li><strong>name</strong>: <em>required (string)</em></li><li><strong>comment</strong>: <em>required (string?)</em></li></ul></li><li><strong>CatOrDog</strong>: <em>required (ApiLib.Cat | ApiLib.Dog)</em></li><li><strong>CatAndDog</strong>: <em>()</em></li><li><strong>PossibleMeetingDate</strong>: <em>required (date-only)</em></li></ul></div><div class="tab-pane" id="api_post_securedby"><h1>Secured by custom_scheme</h1><h3>Headers</h3><ul><li><strong>SpecialToken</strong>: <em>required (string)</em><p>Used to send a custom token.</p></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="entry" class="panel-title">/entry</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_entry"><span class="parent"></span>/entry</a> <span class="methods"><a href="#entry_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#entry_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_entry" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#entry_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"></div><div class="clearfix"></div></div><div onclick="window.location.href = '#entry_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>returns a list of entry</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="entry_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 class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/entry</h4></div><div class="modal-body"><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#entry_post_response" data-toggle="tab">Response</a></li><li><a href="#entry_post_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="entry_post_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>: json</p><p><strong>Content</strong>:</p><pre><code>{
"type": "array",
"items": {
"$ref": "#/definitions/song"
},
"definitions": {
"song": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"artist": {
"type": "string"
}
}
}
}
}
</code></pre></div><div class="tab-pane" id="entry_post_securedby"><h1>Secured by custom_scheme</h1><h3>Headers</h3><ul><li><strong>SpecialToken</strong>: <em>required (string)</em><p>Used to send a custom token.</p></li></ul></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="entry_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 class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/entry</h4></div><div class="modal-body"><div class="alert alert-info"><p>returns a list of entry</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#entry_get_response" data-toggle="tab">Response</a></li><li><a href="#entry_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="entry_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></div><div class="tab-pane" id="entry_get_securedby"><h1>Secured by custom_scheme</h1><h3>Headers</h3><ul><li><strong>SpecialToken</strong>: <em>required (string)</em><p>Used to send a custom token.</p></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="songs" class="panel-title">Songs</h3></div><div class="panel-body"><div class="top-resource-description"><p>Access to all songs inside the music world library.</p></div><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_songs"><span class="parent"></span>/songs</a> <span class="methods"><a href="#songs_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#songs_post"><span class="badge badge_post">post <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_songs" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#songs_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"></div><div class="clearfix"></div></div><div onclick="window.location.href = '#songs_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"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="songs_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 class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/songs</h4></div><div class="modal-body"><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>oauth_2_0</b><p>Dropbox supports OAuth 2.0 for authenticating all API requests.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#songs_get_request" data-toggle="tab">Request</a></li><li><a href="#songs_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="songs_get_request"><h3>Annotations</h3><ul><li><strong>monitoringInterval</strong>:<pre><code>30</code></pre></li></ul><h3>Query Parameters</h3><ul><li><strong>genre</strong>: <em>required (string)</em><p>filter the songs by genre</p></li><li><strong>access_token</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="songs_get_securedby"><h1>Secured by oauth_2_0</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em>required (string)</em><p>Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.</p></li></ul><h1>Secured by</h1></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="songs_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 class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/songs</h4></div><div class="modal-body"><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#songs_post_request" data-toggle="tab">Request</a></li><li><a href="#songs_post_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="songs_post_request"><h3>Query Parameters</h3><ul><li><strong>access_token</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="songs_post_securedby"><h1>Secured by custom_scheme</h1><h3>Headers</h3><ul><li><strong>SpecialToken</strong>: <em>required (string)</em><p>Used to send a custom token.</p></li></ul></div></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_songs__songid_"><span class="parent">/songs</span>/{songId}</a> <span class="methods"><a href="#songs__songid__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_songs__songid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#songs__songid__get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="songs__songid__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 class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/songs</span>/{songId}</h4></div><div class="modal-body"><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>custom_scheme</b><p>A custom security scheme for authenticating requests.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#songs__songid__get_request" data-toggle="tab">Request</a></li><li><a href="#songs__songid__get_response" data-toggle="tab">Response</a></li><li><a href="#songs__songid__get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="songs__songid__get_request"><h3>URI Parameters</h3><ul><li><strong>songId</strong>: <em>required (string)</em></li></ul><h3>Annotations</h3><ul><li><strong>deprecated</strong>:<pre><code>{"date":"2016-02-28T16:41:41.090Z","deprecatedBy":{"firstname":"Christian"},"comment":"no comment"}</code></pre></li></ul></div><div class="tab-pane" id="songs__songid__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>title</strong>: <em>required (string)</em></li><li><strong>length</strong>: <em>required (number)</em></li></ul><p><strong>Examples</strong>:</p><pre><code>{
"title": "My Song",
"length": 12
}</code></pre><pre><code>{
"title": "Last",
"length": 3
}</code></pre><p><strong>Media type</strong>: application/xml</p><p><strong>Type</strong>:</p><pre><code><?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:element name="song">
<xs:complexType>
<xs:sequence>
<xs:element name="title" type="xs:string" />
<xs:element name="artist" type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
</code></pre><p><strong>Examples</strong>:</p><pre><code><?xml version="1.0" encoding="utf-8"?>
<song>
<title>str1234</title>
<artist>str1234</artist>
</song>
</code></pre></div><div class="tab-pane" id="songs__songid__get_securedby"><h1>Secured by custom_scheme</h1><h3>Headers</h3><ul><li><strong>SpecialToken</strong>: <em>required (string)</em><p>Used to send a custom token.</p></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="#api">/api</a></li><li><a href="#entry">/entry</a></li><li><a href="#songs">Songs</a></li></ul></div></div></div></div></body></html>