Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 774 lines (564 sloc) 33.556 kb
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
1 <?xml version="1.0" encoding="UTF-8"?>
2 <application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
4 xmlns:apigee="http://api.apigee.com/wadl/2010/07/"
5 xmlns="http://wadl.dev.java.net/2009/02"
6 xsi:schemaLocation="http://wadl.dev.java.net/2009/02 http://apigee.com/schemas/wadl-schema.xsd http://api.apigee.com/wadl/2010/07/ http://apigee.com/schemas/apigee-wadl-extensions.xsd">
7
8 <!-- Base defines the domain and base path of the endpoint -->
9 <resources base="http://api.nodester.com">
10
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
11 <resource path="coupon">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
12 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
13
14 <!-- Methods should each have a unique id. -->
15 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
16 <method id="request_coupon" name="POST" apigee:displayName="RequestCoupon">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
17
18 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
19 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
20 <apigee:tag primary="true">Coupon</apigee:tag>
21 <apigee:tag>RequestCoupon</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
22 </apigee:tags>
23
24 <!-- Is authentication required for this method? -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
25 <apigee:authentication required="false" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
26
27 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
28 <apigee:example url="/coupon" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
29
30 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
31 <doc title="" apigee:url="http://nodester.com/api.html">
32 Submits a registration coupon request for nodester node.js hosting.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
33 </doc>
34
35 <request>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
36 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
37 <param name="email" required="true" type="xsd:string" style="query" default="">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
38 <!-- Docs are optional, but recommended. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
39 <doc>The email address where you would like the nodester coupon sent</doc>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
40 </param>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
41 </request>
42
43 </method>
44 </resource>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
45
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
46 <resource path="user">
47 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
48
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
49 <!-- Methods should each have a unique id. -->
50 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
51 <method id="create_user" name="POST" apigee:displayName="CreateUser">
52
53 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
54 <apigee:tags>
55 <apigee:tag primary="true">User</apigee:tag>
56 <apigee:tag>CreateUser</apigee:tag>
57 </apigee:tags>
58
59
60 <!-- Is authentication required for this method? -->
61 <apigee:authentication required="false" />
62
63 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
64 <apigee:example url="/user" />
65
66 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
67 <doc title="" apigee:url="http://nodester.com/api.html">
68 Creates a nodester user account with the coupon code received.
69 </doc>
70
71 <request>
72 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
73
74 <param name="coupon" required="true" type="xsd:string" style="query" default="">
75 <doc>Coupon code received from nodester</doc>
76 </param>
77 <param name="user" required="true" type="xsd:string" style="query" default="">
78 <doc>Desired username on nodester</doc>
79 </param>
80 <param name="password" required="true" type="xsd:string" style="query" default="">
81 <doc>Desired password on nodester (do not use special characters like @ symbol)</doc>
82 </param>
83 <param name="email" required="true" type="xsd:string" style="query" default="">
84 <doc>Desired email address on nodester</doc>
85 </param>
86 <param name="rsakey" required="true" type="xsd:string" style="query" default="">
87 <doc>Your RSA key. Ensure that all + in the ssh key are substituted for their %2B counter parts, else your key will break. Run this on your command line to copy your RSA string and swap out the plus signs: "cat ~/.ssh/id_rsa.pub | sed s/'+'/'%2B'/g | pbcopy</doc>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
88 </param>
89
90 </request>
91
92 </method>
93
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
94 <!-- Methods should each have a unique id. -->
95 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
96 <method id="update_user" name="PUT" apigee:displayName="UpdateUser">
97
98 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
99 <apigee:tags>
100 <apigee:tag primary="true">User</apigee:tag>
101 <apigee:tag>UpdateUser</apigee:tag>
102 </apigee:tags>
103
104
105 <!-- Is authentication required for this method? -->
106 <apigee:authentication required="true" />
107
108 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
109 <apigee:example url="/user" />
110
111 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
112 <doc title="" apigee:url="http://nodester.com/api.html">
113 Update a nodester user account i.e. change password, email, rsakey.
114 </doc>
115
116 <request>
117 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
118
119 <param name="password" required="false" type="xsd:string" style="query" default="">
120 <doc>Desired password on nodester (do not use special characters like @ symbol)</doc>
121 </param>
122 <param name="email" required="false" type="xsd:string" style="query" default="">
123 <doc>Desired email address on nodester</doc>
124 </param>
125 <param name="rsakey" required="false" type="xsd:string" style="query" default="">
126 <doc>Your RSA key. Ensure that all + in the ssh key are substituted for their %2B counter parts, else your key will break. Run this on your command line to copy your RSA string and swap out the plus signs: "cat ~/.ssh/id_rsa.pub | sed s/'+'/'%2B'/g | pbcopy</doc>
127 </param>
128
129 </request>
130
131 </method>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
132
133 <!-- Methods should each have a unique id. -->
134 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
135 <method id="delete_user" name="DELETE" apigee:displayName="DeleteUser">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
136
137 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
138 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
139 <apigee:tag primary="true">User</apigee:tag>
140 <apigee:tag>DeleteUser</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
141 </apigee:tags>
142
143
144 <!-- Is authentication required for this method? -->
145 <apigee:authentication required="true" />
146
147 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
148 <apigee:example url="/user" />
149
150 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
151 <doc title="" apigee:url="http://nodester.com/api.html">
152 Delete your nodester user account.
153 </doc>
154
155 </method>
156 </resource>
157
158 <resource path="apps">
159 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
160
161 <!-- Methods should each have a unique id. -->
162 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
163 <method id="get_apps" name="GET" apigee:displayName="GetApps">
164
165 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
166 <apigee:tags>
167 <apigee:tag primary="true">Apps</apigee:tag>
168 <apigee:tag>GetApps</apigee:tag>
169 </apigee:tags>
170
171 <!-- Is authentication required for this method? -->
172 <apigee:authentication required="true" />
173
174 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
175 <apigee:example url="/apps" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
176
177 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
178 <doc title="" apigee:url="http://nodester.com/api.html">
179 Gets a listing of your nodester apps.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
180 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
181
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
182 </method>
183 </resource>
184
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
185 <resource path="app">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
186 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
187
188 <!-- Methods should each have a unique id. -->
189 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
190 <method id="create_app" name="POST" apigee:displayName="CreateApp">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
191
192 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
193 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
194 <apigee:tag primary="true">App</apigee:tag>
195 <apigee:tag>CreateApp</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
196 </apigee:tags>
197
198
199 <!-- Is authentication required for this method? -->
200 <apigee:authentication required="true" />
201
202 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
203 <apigee:example url="/app" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
204
205 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
206 <doc title="" apigee:url="http://nodester.com/api.html">
207 Creates a nodester application.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
208 </doc>
209
210 <request>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
211 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
212
213 <param name="appname" required="true" type="xsd:string" style="query" default="">
214 <doc>Desired application name on nodester</doc>
215 </param>
216 <param name="start" required="false" type="xsd:string" style="query" default="">
217 <doc>Name of your starting javascript file if not server.js</doc>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
218 </param>
219
220 </request>
221
222 </method>
223
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
224 <!-- Methods should each have a unique id. -->
225 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
226 <method id="update_app" name="PUT" apigee:displayName="UpdateApp">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
227
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
228 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
229 <apigee:tags>
230 <apigee:tag primary="true">App</apigee:tag>
231 <apigee:tag>UpdateApp</apigee:tag>
232 </apigee:tags>
233
234
235 <!-- Is authentication required for this method? -->
236 <apigee:authentication required="true" />
237
238 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
239 <apigee:example url="/app" />
240
241 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
242 <doc title="" apigee:url="http://nodester.com/api.html">
243 Update a nodester application i.e. change its starting javascript file name.
244 </doc>
245
246 <request>
247 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
248
249 <param name="appname" required="true" type="xsd:string" style="query" default="">
250 <doc>Desired application name on nodester</doc>
251 </param>
252 <param name="start" required="false" type="xsd:string" style="query" default="">
253 <doc>Name of your starting javascript file if not server.js</doc>
254 </param>
255
256 </request>
257
258 </method>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
259
260 <!-- Methods should each have a unique id. -->
261 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
262 <method id="startstop_app" name="PUT" apigee:displayName="StartStopApp">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
263
264 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
265 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
266 <apigee:tag primary="true">App</apigee:tag>
267 <apigee:tag>Start/Stop App</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
268 </apigee:tags>
269
270
271 <!-- Is authentication required for this method? -->
272 <apigee:authentication required="true" />
273
274 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
275 <apigee:example url="/app" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
276
277 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
278 <doc title="" apigee:url="http://nodester.com/api.html">
279 Start or stop a nodester application.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
280 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
281
282 <request>
283 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
284
285 <param name="appname" required="true" type="xsd:string" style="query" default="">
286 <doc>Desired application name on nodester</doc>
287 </param>
288 <param name="running" required="true" type="xsd:string" style="query" default="true">
289 <doc>Set running to true or false to start or stop your application</doc>
290 </param>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
291
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
292 </request>
293
294 </method>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
295
296
297 <!-- Methods should each have a unique id. -->
298 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
299 <method id="delete_app" name="DELETE" apigee:displayName="DeleteApp">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
300
301 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
302 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
303 <apigee:tag primary="true">App</apigee:tag>
304 <apigee:tag>DeleteApp</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
305 </apigee:tags>
306
307
308 <!-- Is authentication required for this method? -->
309 <apigee:authentication required="true" />
310
311 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
312 <apigee:example url="/app" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
313
314 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
315 <doc title="" apigee:url="http://nodester.com/api.html">
316 Delete your nodester application.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
317 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
318
319 <request>
320 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
321
322 <param name="appname" required="true" type="xsd:string" style="query" default="">
323 <doc>Name of application to delete on nodester</doc>
324 </param>
325
326 </request>
327
328 </method>
329
330
331 <method id="app_info" name="GET" apigee:displayName="GetAppInfo">
332
333 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
334 <apigee:tags>
335 <apigee:tag primary="true">App</apigee:tag>
336 <apigee:tag>GetAppInfo</apigee:tag>
337 </apigee:tags>
338
339
340 <!-- Is authentication required for this method? -->
341 <apigee:authentication required="true" />
342
343 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
344 <apigee:example url="/app/{appname}" />
345
346 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
347 <doc title="" apigee:url="http://nodester.com/api.html">
348 Get information about your nodester application.
349 </doc>
350
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
351 </method>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
352
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
353 </resource>
354
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
355
356 <resource path="applogs">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
357 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
358
359 <!-- Methods should each have a unique id. -->
360 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
361 <method id="request_applogs" name="GET" apigee:displayName="RequestAppLogs">
362
363 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
364 <apigee:tags>
365 <apigee:tag primary="true">AppLogs</apigee:tag>
366 <apigee:tag>RequestAppLogs</apigee:tag>
367 </apigee:tags>
368
369 <!-- Is authentication required for this method? -->
370 <apigee:authentication required="true" />
371
372 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
373 <apigee:example url="/applogs/{appname}" />
374
375 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
376 <doc title="" apigee:url="http://nodester.com/api.html">
377 Fetch your nodester application logs.
378 </doc>
379
380 </method>
381 </resource>
382
383 <resource path="env">
384 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
385
386 <!-- Methods should each have a unique id. -->
387 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
388 <method id="get_env" name="GET" apigee:displayName="GetEnv">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
389
390 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
391 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
392 <apigee:tag primary="true">Env</apigee:tag>
393 <apigee:tag>GetEnv</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
394 </apigee:tags>
395
396
397 <!-- Is authentication required for this method? -->
398 <apigee:authentication required="true" />
399
400 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
401 <apigee:example url="/env" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
402
403 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
404 <doc title="" apigee:url="http://nodester.com/api.html">
405 Gets environment information on a key.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
406 </doc>
407
408 <request>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
409 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
410
411 <param name="appname" required="true" type="xsd:string" style="query" default="">
412 <doc>Provide nodester application name</doc>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
413 </param>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
414 <param name="key" required="true" type="xsd:string" style="query" default="">
415 <doc>Provide nodester environment key</doc>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
416 </param>
417
418 </request>
419
420 </method>
421
422 <!-- Methods should each have a unique id. -->
423 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
424 <method id="update_env" name="PUT" apigee:displayName="UpdateEnv">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
425
426 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
427 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
428 <apigee:tag primary="true">Env</apigee:tag>
429 <apigee:tag>UpdateEnv</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
430 </apigee:tags>
431
432
433 <!-- Is authentication required for this method? -->
434 <apigee:authentication required="true" />
435
436 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
437 <apigee:example url="/env" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
438
439 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
440 <doc title="" apigee:url="http://nodester.com/api.html">
441 Update a nodester environment key.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
442 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
443
444 <request>
445 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
446
447 <param name="appname" required="true" type="xsd:string" style="query" default="">
448 <doc>Provide nodester application name</doc>
449 </param>
450 <param name="key" required="true" type="xsd:string" style="query" default="">
451 <doc>Provide nodester environment key</doc>
452 </param>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
453
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
454 </request>
455
456 </method>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
457
458 <!-- Methods should each have a unique id. -->
459 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
460 <method id="delete_env" name="DELETE" apigee:displayName="DeleteEnv">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
461
462 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
463 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
464 <apigee:tag primary="true">Env</apigee:tag>
465 <apigee:tag>DeleteEnv</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
466 </apigee:tags>
467
468
469 <!-- Is authentication required for this method? -->
470 <apigee:authentication required="true" />
471
472 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
473 <apigee:example url="/env" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
474
475 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
476 <doc title="" apigee:url="http://nodester.com/api.html">
477 Delete nodester environment key.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
478 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
479
480 <request>
481 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
482
483 <param name="appname" required="true" type="xsd:string" style="query" default="">
484 <doc>Provide nodester application name</doc>
485 </param>
486 <param name="key" required="true" type="xsd:string" style="query" default="">
487 <doc>Provide nodester environment key</doc>
488 </param>
489
490 </request>
491
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
492 </method>
493 </resource>
494
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
495 <resource path="status">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
496 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
497
498 <!-- Methods should each have a unique id. -->
499 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
500 <method id="get_status" name="GET" apigee:displayName="GetStatus">
501
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
502 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
503 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
504 <apigee:tag primary="true">Status</apigee:tag>
505 <apigee:tag>GetStatus</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
506 </apigee:tags>
507
508 <!-- Is authentication required for this method? -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
509 <apigee:authentication required="false" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
510
511 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
512 <apigee:example url="/status" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
513
514 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
515 <doc title="" apigee:url="http://nodester.com/api.html">
516 Gets nodester system status.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
517 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
518
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
519 </method>
520 </resource>
521
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
522 <resource path="npm">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
523 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
524
525 <!-- Methods should each have a unique id. -->
526 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
527 <method id="npm_install" name="POST" apigee:displayName="NPMinstall">
528
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
529 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
530 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
531 <apigee:tag primary="true">NPM</apigee:tag>
532 <apigee:tag>NPMinstall</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
533 </apigee:tags>
534
535 <!-- Is authentication required for this method? -->
536 <apigee:authentication required="true" />
537
538 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
539 <apigee:example url="/npm" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
540
541 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
542 <doc title="" apigee:url="http://nodester.com/api.html">
543 Install, uninstall, and update NPM modules on your nodester application.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
544 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
545
546 <request>
547 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
548 <param name="appname" required="true" type="xsd:string" style="query" default="">
549 <!-- Docs are optional, but recommended. -->
550 <doc>Provide nodester application name</doc>
551 </param>
552 <param name="action" required="true" type="xsd:string" style="query" default="install">
553 <!-- Docs are optional, but recommended. -->
554 <doc>Values can be install, uninstall, or update</doc>
555 </param>
556 <param name="package" required="true" type="xsd:string" style="query" default="">
557 <!-- Docs are optional, but recommended. -->
558 <doc>Provide the name of the NPM module</doc>
559 </param>
560 </request>
561
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
562 </method>
563 </resource>
564
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
565 <resource path="appdomains">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
566 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
567
568 <!-- Methods should each have a unique id. -->
569 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
570 <method id="get_domains" name="GET" apigee:displayName="GetDomains">
571
572 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
573 <apigee:tags>
574 <apigee:tag primary="true">AppDomains</apigee:tag>
575 <apigee:tag>GetDomains</apigee:tag>
576 </apigee:tags>
577
578
579 <!-- Is authentication required for this method? -->
580 <apigee:authentication required="true" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
581
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
582 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
583 <apigee:example url="/appdomains" />
584
585 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
586 <doc title="" apigee:url="http://nodester.com/api.html">
587 Gets list of your domains.
588 </doc>
589
590 </method>
591
592 <!-- Methods should each have a unique id. -->
593 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
594 <method id="create_domain" name="POST" apigee:displayName="CreateDomain">
595
596 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
597 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
598 <apigee:tag primary="true">AppDomains</apigee:tag>
599 <apigee:tag>CreateDomain</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
600 </apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
601
602
603 <!-- Is authentication required for this method? -->
604 <apigee:authentication required="true" />
605
606 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
607 <apigee:example url="/appdomains" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
608
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
609 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
610 <doc title="" apigee:url="http://nodester.com/api.html">
611 Creates app domain for hosting example.com.
612 </doc>
613
614 <request>
615 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
616
617 <param name="appname" required="true" type="xsd:string" style="query" default="">
618 <doc>Provide nodester application name</doc>
619 </param>
620 <param name="domain" required="true" type="xsd:string" style="query" default="">
621 <doc>Provide your domain such as example.com to nodester</doc>
622 </param>
623
624 </request>
625
626 </method>
627
628 <!-- Methods should each have a unique id. -->
629 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
630 <method id="delete_domain" name="DELETE" apigee:displayName="DeleteDomain">
631
632 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
633 <apigee:tags>
634 <apigee:tag primary="true">AppDomains</apigee:tag>
635 <apigee:tag>DeleteDomain</apigee:tag>
636 </apigee:tags>
637
638
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
639 <!-- Is authentication required for this method? -->
640 <apigee:authentication required="true" />
641
642 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
643 <apigee:example url="/appdomains" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
644
645 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
646 <doc title="" apigee:url="http://nodester.com/api.html">
647 Deletes app domain for hosting example.com.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
648 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
649
650 <request>
651 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
652
653 <param name="appname" required="true" type="xsd:string" style="query" default="">
654 <doc>Provide nodester application name</doc>
655 </param>
656 <param name="domain" required="true" type="xsd:string" style="query" default="">
657 <doc>Provide your domain such as example.com to nodester</doc>
658 </param>
659
660 </request>
661
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
662 </method>
663 </resource>
664
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
665 <resource path="reset_password">
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
666 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
667
668 <!-- Methods should each have a unique id. -->
669 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
670 <method id="reset_password_post" name="POST" apigee:displayName="ResetPasswordRequest">
671
672 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
673 <apigee:tags>
674 <apigee:tag primary="true">ResetPassword</apigee:tag>
675 <apigee:tag>ResetPasswordRequest</apigee:tag>
676 </apigee:tags>
677
678
679 <!-- Is authentication required for this method? -->
680 <apigee:authentication required="false" />
681
682 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
683 <apigee:example url="/reset_password" />
684
685 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
686 <doc title="" apigee:url="http://nodester.com/api.html">
687 Sends a e-mail with a token to reset your user password.
688 </doc>
689
690 <request>
691 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
692
693 <param name="user" required="true" type="xsd:string" style="query" default="">
694 <doc>Provide your nodester username</doc>
695 </param>
696
697 </request>
698
699 </method>
700
701 <!-- Methods should each have a unique id. -->
702 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
703 <method id="reset_password_put" name="PUT" apigee:displayName="ResetPasswordToken">
704
705 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
706 <apigee:tags>
707 <apigee:tag primary="true">ResetPassword</apigee:tag>
708 <apigee:tag>ResetPasswordToken</apigee:tag>
709 </apigee:tags>
710
711
712 <!-- Is authentication required for this method? -->
713 <apigee:authentication required="true" />
714
715 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
716 <apigee:example url="/reset_password/{token}" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
717
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
718 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
719 <doc title="" apigee:url="http://nodester.com/api.html">
720 Updates your password using the provided token.
721 </doc>
722
723 <request>
724 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
725
726 <param name="password" required="true" type="xsd:string" style="query" default="">
727 <doc>Provide your new nodester password</doc>
728 </param>
729
730 </request>
731
732 </method>
733
734 </resource>
735
736 <resource path="gitreset">
737 <!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
738
739 <!-- Methods should each have a unique id. -->
740 <!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
741 <method id="git-reset" name="POST" apigee:displayName="GitReset">
742
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
743 <!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
744 <apigee:tags>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
745 <apigee:tag primary="true">GitReset</apigee:tag>
746 <apigee:tag>GitReset</apigee:tag>
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
747 </apigee:tags>
748
749 <!-- Is authentication required for this method? -->
750 <apigee:authentication required="true" />
751
752 <!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
753 <apigee:example url="/gitreset" />
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
754
755 <!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
756 <doc title="" apigee:url="http://nodester.com/api.html">
757 Resets your Nodester git repository and npm list.
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
758 </doc>
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
759
760 <request>
761 <param name="Content-Type" required="true" type="xsd:string" style="header" default="application/x-www-form-urlencoded"/>
762 <param name="appname" required="true" type="xsd:string" style="query" default="">
763 <!-- Docs are optional, but recommended. -->
764 <doc>Provide nodester appname to reset</doc>
765 </param>
766 </request>
767
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
768 </method>
769 </resource>
770
771
7916e96 @chrismatthieu full api coverage
chrismatthieu authored
772
2f8e10d @chrismatthieu initial checkin
chrismatthieu authored
773 </resources>
774 </application>
Something went wrong with that request. Please try again.