forked from cloudera/cm_api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-docs.fmt
1560 lines (1466 loc) · 56.6 KB
/
api-docs.fmt
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
[#ftl]
[#-- ============================================================================================== --]
[#-- File modified from the standard Enunciate FreeMarker template: --]
[#-- https://github.com/stoicflame/enunciate/blob/master/docs/src/main/resources/org/codehaus/enunciate/modules/docs/docs.fmt --]
[#-- ============================================================================================== --]
[#assign soapAvailable=docsxml.soap.wsdls.wsdl.endpointInterface?size > 0/]
[#assign restAvailable=docsxml.rest.resources.resource?size > 0/]
[#assign apiRelativePath="../.."/]
[#function scrubPathToFilename path]
[#return "path_" + path?string?replace("/", "_")?replace(":","-")?replace("{", "-")?replace("}", "-") + ".html"/]
[/#function]
[#function tocNeeded(nodelist)]
[#return nodelist?size > 2/]
[/#function]
[#function attributeExists(node)]
[#if node?size??]
[#--if there is a 'size' property, then it's not an attribute--]
[#return node?size > 0/]
[#else]
[#return node?node_type = "attribute"/]
[/#if]
[/#function]
[#function isDeprecated element]
[#list element.tag as tag]
[#if tag.@name="deprecated"]
[#return true/]
[/#if]
[/#list]
[#return false/]
[/#function]
[#--set up the subnavigation menus--]
[#assign nav_sections = { "Data Model" : "model.html"} /]
[#if soapAvailable]
[#assign nav_sections = nav_sections + { "SOAP" : "soap.html" }/]
[/#if]
[#if restAvailable]
[#assign nav_sections = nav_sections + { "REST" : "rest.html" }/]
[/#if]
[#if downloadsxml??]
[#assign nav_sections = nav_sections + { "Files and Libraries" : "downloads.html"} /]
[/#if]
[#assign nav_resource_groups = {}/]
[#list docsxml.rest.groups.group?sort as group]
[#assign nav_resource_groups = nav_resource_groups + { group : "resource_" + group + ".html"}/]
[/#list]
[#assign nav_paths = {}/]
[#list docsxml.rest.resources.resource?sort_by("@name") as resource]
[#assign nav_paths = nav_paths + {resource.@name?string : scrubPathToFilename(resource.@name)}/]
[/#list]
[#assign nav_wsdls = {}/]
[#assign nav_eis_by_ns = {}/]
[#list docsxml.soap.wsdls.wsdl as wsdl]
[#assign nav_wsdls = nav_wsdls + {wsdl.@namespaceId?string : "soap_" + wsdl.@namespaceId?string + ".html"}/]
[#assign nav_eis_by_ns = nav_eis_by_ns + {wsdl.@namespaceId?string : {}}/]
[#list wsdl.endpointInterface?sort_by("@name") as endpointInterface]
[#assign tmp = nav_eis_by_ns[wsdl.@namespaceId?string] + {endpointInterface.@name?string : "soap_" + wsdl.@namespaceId?string + "_" + endpointInterface.@name?string + ".html"}/]
[#assign nav_eis_by_ns = nav_eis_by_ns + {wsdl.@namespaceId?string : tmp}/]
[/#list]
[/#list]
[#assign nav_models = {}/]
[#assign nav_typedefs_by_ns = {}/]
[#assign nav_elements_by_ns = {}/]
[#list docsxml.data.schema as schema]
[#assign nav_models = nav_models + {schema.@namespaceId?string : schema.@namespaceId?string + ".html"}/]
[#assign nav_elements_by_ns = nav_elements_by_ns + {schema.@namespaceId?string : {}}/]
[#list schema.elements.element?sort_by("@name") as element]
[#assign tmp = nav_elements_by_ns[schema.@namespaceId?string] + { element.@name?string + " element" : "el_" + schema.@namespaceId?string + "_" + element.@name?string + ".html"}/]
[#assign nav_elements_by_ns = nav_elements_by_ns + {schema.@namespaceId?string : tmp}/]
[/#list]
[#assign nav_typedefs_by_ns = nav_typedefs_by_ns + {schema.@namespaceId?string : {}}/]
[#list schema.types.type?sort_by("@name") as type]
[#assign tmp = nav_typedefs_by_ns[schema.@namespaceId?string] + {type.@name?string : schema.@namespaceId?string + "_" + type.@name?string + ".html"}/]
[#assign nav_typedefs_by_ns = nav_typedefs_by_ns + {schema.@namespaceId?string : tmp}/]
[/#list]
[/#list]
[#macro boilerplate title=docsxml.@title!"Web API" subnav=[{"title" : "Home", "href" : indexPageName}] codeblocks=false]
<!doctype html>
<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ -->
<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]-->
<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]-->
<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]-->
<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame
Remove this if you use the .htaccess -->
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>${title}</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- CSS: implied media="all" -->
<link rel="stylesheet" href="css/style.css?v=2">
<link rel="stylesheet" href="css/prettify.css">
<!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects -->
<script src="js/libs/modernizr-1.7.min.js"></script>
</head>
<body class="home">
<div class="container">
<header>
<div id="header" class="column first last span-20">
<div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="${indexPageName}">${title}</a></div>
<div id="primary" class="column span-18 append-1 prepend-1 first last">
<ul class="navigation">
[#if soapAvailable]
<li id="nav-soap"><a href="soap.html">SOAP</a></li>
[/#if]
[#if restAvailable]
<li id="nav-rest"><a href="rest.html">REST</a></li>
[/#if]
<li id="nav-data"><a href="model.html">Data Model</a></li>
[#if downloadsxml??]
<li id="nav-downloads"><a href="downloads.html">Files and Libraries</a></li>
[/#if]
</ul>
</div>
<div>
<ul class="xbreadcrumbs" id="breadcrumbs">
[#list subnav as crumb]
<li[#if !crumb_has_next] class="current"[/#if]>
<a href="${crumb.href}"[#if crumb_index = 0] class="home"[/#if]>${crumb.title}</a>[#if crumb_has_next] >[/#if]
[#if crumb.subnav??]
<ul>
[#list crumb.subnav?keys as label]
<li><a href="${crumb.subnav[label]}">${label}</a></li>
[/#list]
</ul>
[/#if]
</li>
[/#list]
</ul>
</div>
</div>
</header>
<div id="main" class="column first last span-20">
[#nested/]
<div class="clear"></div>
</div>
<footer>
<div id="footer">
[#if attributeExists(docsxml.@copyright)]
Copyright © <script type="text/javascript">d = new Date;document.write(d.getFullYear());</script> <span>${docsxml.@copyright}</span><br/>
[/#if]
Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>.
</div>
</footer>
</div> <!--! end of #container -->
<!-- JavaScript at the bottom for fast page loading -->
<!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script>
<script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script>
<!--manage the navigation menu-->
<script src="js/libs/xbreadcrumbs.js"></script>
<script>
$(function() {
$('#breadcrumbs').xBreadcrumbs();
});
</script>
[#if codeblocks]
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="js/libs/prettify/prettify.js"></script>
<script>
$(function() {
prettyPrint();
});
</script>
[/#if]
<!--[if lt IE 7 ]>
<script src="js/libs/dd_belatedpng.js"></script>
<script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script>
<![endif]-->
[#--
todo: uncomment to support google analytics measurements...
<!-- mathiasbynens.be/notes/async-analytics-snippet Change UA-XXXXX-X to be your site's ID -->
<script>
var _gaq=[["_setAccount","UA-XXXXX-X"],["_trackPageview"]];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];g.async=1;
g.src=("https:"==location.protocol?"//ssl":"//www")+".google-analytics.com/ga.js";
s.parentNode.insertBefore(g,s)}(document,"script"));
</script>
--]
</body>
</html>
[/#macro]
[@file name=indexPageName charset="utf-8"]
[@boilerplate]
[#if docsxml.documentation?size > 0]
<h1>Introduction</h1>
<p>${docsxml.documentation}</p>
[/#if]
[#if restAvailable]
<p>HTTP requests should set the "Content-Type" header to "application/json"
for most calls, unless specified otherwise.</p>
<h3>Authentication</h3>
<p>
The Cloudera Manager API uses <a href="http://tools.ietf.org/html/rfc2617">HTTP
basic access authentication</a>. It accepts the same user credentials
as the web interface. Different users may have different levels of access,
as defined by their roles. (See the user management API calls for more.)
With every authenticated request, the server returns a session cookie,
which can be subsequently used for authentication.
</p>
<h3>Error Code</h3>
<p>The API returns HTTP code in the 400s and 500s upon errors:
<ul>
<li>400 — Invalid request parameters; Malformed requests</li>
<li>401 — Authentication failure</li>
<li>403 — Authorization failure</li>
<li>404 — Object not found</li>
<li>500 — Internal API error</li>
<li>503 — Response temporarily unavailable; caller should retry later</li>
</ul>
<p>See <a href="path__tools_echoError.html">/tools/echoError</a> for a
discussion on the body of an error response.<p>
<h1>API Usage Tutorial</h1>
<p><a href="tutorial.html">Tutorial link.</a></p>
<h1>API Version</h1>
<p>
The API can be queried for the latest version it supports. By
making a GET request to the '/version' URL, a string will be
returned with the highest supported version (for example, "v2").
</p>
<p>
Note that servers that only support API v1 do not support this
call. In that case, a 404 error will be returned, and can be
used to detect that the server only supports v1.
</p>
<p>
The version should be prepended to the path of the REST resources
listed below. The documentation of the different resources lists
the version which added the particular functionality.
</p>
<h1>REST Resources</h1>
<p>
This API supports a <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">Representational State Transfer (REST)</a>
model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:
</p>
<ul>
[#if ((groupRestResources!"byDocumentationGroup") != "byPath") && docsxml.rest.groups.group?size > 0]
[#list docsxml.rest.groups.group?sort as group]
[@processResourceGroup group=group/]
<li><a href="resource_${group}.html">${group}</a></li>
[/#list]
[#else]
[#list docsxml.rest.resources.resource?sort_by("@name") as resource]
[@processResource resource=resource/]
<li><a href="${scrubPathToFilename(resource.@name)}">${resource.@name}</a></li>
[/#list]
[/#if]
</ul>
[#if attributeExists(docsxml.rest.@wadl)]
<p>
There is also a <a href="${docsxml.rest.@wadl}">WADL document</a> describing the REST API.
</p>
[/#if]
[/#if]
[#if soapAvailable]
<h1>SOAP Endpoints</h1>
<p>
This API is exposed through a set of <a href="http://www.ws-i.org/Profiles/BasicProfile-1.0.html">WSI Basic Profile</a>
-compliant SOAP v1.1 endpoints. The API supports <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/">XML-binary Optimized Pacakging (XOP)</a>
and <a href="http://www.w3.org/TR/2004/WD-soap12-mtom-20040608/">SOAP Message Transmission Optimization Mechanism (MTOM)</a>
for transmission of binary data. The SOAP API is described by the following endpoints:
</p>
[#list docsxml.soap.wsdls.wsdl as wsdl]
[@processWsdl wsdl=wsdl/]
<h2>Namespace "${wsdl.@namespaceId}"</h2>
<table>
<tr>
<td align="right">Namespace URI:</td>
<td>[#if wsdl.@namespace?length > 0]${wsdl.@namespace}[#else](default namespace)[/#if]</td>
</tr>
[#if attributeExists(wsdl.@file)]
<tr>
<td align="right">WSDL:</td>
<td><a href="${wsdl.@file}">${wsdl.@file}</a></td>
</tr>
[/#if]
</table>
<h3>Endpoints</h3>
<ul>
[#list wsdl.endpointInterface?sort_by("@name") as endpointInterface]
[@processEndpointInterface endpointInterface=endpointInterface/]
<li[#if isDeprecated(endpointInterface)] class="deprecated"[/#if]><a href="soap_${wsdl.@namespaceId}_${endpointInterface.@name}.html">${endpointInterface.@name}</a></li>
[/#list]
</ul>
[/#list]
[#if downloadsxml??]
<p>
The SOAP API is also accessible by a set of client-side libraries that can be downloaded from the <a href="downloads.html">files and libraries page</a>.
</p>
[/#if]
[/#if]
<h1>Data Model</h1>
<p>
All endpoints act on a common set of data. The Cloudera Manager API uses <a href="http://json.org">JSON</a>.
</p>
[#list docsxml.data.schema as schema]
[@processSchema schema=schema/]
[#if schema.elements.element?size > 0]
<h3>Data Elements</h3>
<ul>
[#list schema.elements.element?sort_by("@name") as element]
<li[#if isDeprecated(element)] class="deprecated"[/#if]><a href="el_${schema.@namespaceId}_${element.@name}.html">${element.@name}</a></li>
[/#list]
</ul>
[/#if]
[/#list]
[#if docsxml.data.jsonSchema.type?size > 0]
<h1>JSON Data Types</h1>
<ul>
[#list docsxml.data.jsonSchema.type as type]
[@processJsonType type=type/]
<li[#if isDeprecated(type)] class="deprecated"[/#if]><a href="json_" + type?parent.@schemaId + "_" + type.@name + ".html">${type.@name}</a></li>
[/#list]
</ul>
[/#if]
[/@boilerplate]
[/@file]
[@file name="model.html" charset="utf-8"]
[@boilerplate title="Data Model" subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "Data Model" , "href" : "model.html", "subnav" : nav_sections}]]
<h1>Data Model</h1>
<p>
All endpoints act on a common set of data. The Cloudera Manager API uses <a href="http://json.org">JSON</a>.
</p>
[#list docsxml.data.schema as schema]
[#if schema.elements.element?size > 0]
<h3>Data Elements</h3>
<ul>
[#list schema.elements.element?sort_by("@name") as element]
<li[#if isDeprecated(element)] class="deprecated"[/#if]><a href="el_${schema.@namespaceId}_${element.@name}.html">${element.@name}</a></li>
[/#list]
</ul>
[/#if]
[/#list]
[/@boilerplate]
[/@file]
[#if downloadsxml??]
[@file name="downloads.html" charset="utf-8"]
[@boilerplate title="Files and Libraries" subnav=[{"title" : "Home", "href" : indexPageName}, { "title" : "Files and Libraries" , "href" : "downloads.html" , "subnav" : nav_sections}] codeblocks=true]
<h1>Files and Libraries</h1>
<p>The following files and libraries are available:</p>
<h3>Client Library</h3>
<ul>
<li><a href="https://github.com/cloudera/cm_api">https://github.com/cloudera/cm_api</a></li>
</ul>
<ul>
[#list downloadsxml.download as download]
<li><a href="#${download.@name}">${download.@name}</a></li>
[/#list]
</ul>
[#list downloadsxml.download as download]
<a name="${download.@name}"></a>
<h2>${download.@name}</h2>
[#list download.created as created]
<p class="note">Created ${created}</p>
[/#list]
[#list download.description as description]
<p>${description}</p>
[/#list]
<h3>Files</h3>
<table>
<tr>
<th>name</th>
<th>size</th>
[#if download.files.file?size > 1]
<th>description</th>
[/#if]
</tr>
[#list download.files.file as file]
<tr>
<td><a href="${file.@name}">${file.@name}</a></td>
<td>${file.@size}</td>
[#if file_index > 0 || file_has_next]
<td>${file}</td>
[/#if]
</tr>
[/#list]
</table>
[/#list]
[/@boilerplate]
[/@file]
[/#if]
[#if restAvailable]
[@file name="rest.html" charset="utf-8"]
[@boilerplate title="REST" subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "REST" , "href" : "rest.html", "subnav" : nav_sections}]]
<h1>REST Resources</h1>
<p>
This API supports a <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">Representational State Transfer (REST)</a>
model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:
</p>
<ul>
[#if ((groupRestResources!"byDocumentationGroup") != "byPath") && docsxml.rest.groups.group?size > 0]
[#list docsxml.rest.groups.group?sort as group]
<li><a href="resource_${group}.html">${group}</a></li>
[/#list]
[#else]
[#list docsxml.rest.resources.resource?sort_by("@name") as resource]
<li><a href="${scrubPathToFilename(resource.@name)}">${resource.@name}</a></li>
[/#list]
[/#if]
</ul>
[#if attributeExists(docsxml.rest.@wadl)]
<p>
There is also a <a href="${docsxml.rest.@wadl}">WADL document</a> describing the REST API.
</p>
[/#if]
[/@boilerplate]
[/@file]
[/#if]
[#if soapAvailable]
[@file name="soap.html" charset="utf-8"]
[@boilerplate title="SOAP" subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "SOAP" , "href" : "soap.html", "subnav" : nav_sections}]]
<h1>SOAP Endpoints</h1>
<p>
This API is exposed through a set of <a href="http://www.ws-i.org/Profiles/BasicProfile-1.0.html">WSI Basic Profile</a>
-compliant SOAP v1.1 endpoints. The API supports <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/">XML-binary Optimized Pacakging (XOP)</a>
and <a href="http://www.w3.org/TR/2004/WD-soap12-mtom-20040608/">SOAP Message Transmission Optimization Mechanism (MTOM)</a>
for transmission of binary data. The SOAP API is fully described by the following endpoints:
</p>
[#list docsxml.soap.wsdls.wsdl as wsdl]
<h2>Namespace "${wsdl.@namespaceId}"</h2>
<table>
<tr>
<td align="right">Namespace URI:</td>
<td>[#if wsdl.@namespace?length > 0]${wsdl.@namespace}[#else](default namespace)[/#if]</td>
</tr>
[#if attributeExists(wsdl.@file)]
<tr>
<td align="right">WSDL:</td>
<td><a href="${wsdl.@file}">${wsdl.@file}</a></td>
</tr>
[/#if]
</table>
<h3>Endpoints</h3>
<ul>
[#list wsdl.endpointInterface?sort_by("@name") as endpointInterface]
<li[#if isDeprecated(endpointInterface)] class="deprecated"[/#if]><a href="soap_${wsdl.@namespaceId}_${endpointInterface.@name}.html">${endpointInterface.@name}</a></li>
[/#list]
</ul>
[/#list]
[#if downloadsxml??]
<p>
The SOAP API is also accessible by a set of client-side libraries that can be downloaded from the <a href="downloads.html">files and libraries page</a>.
</p>
[/#if]
[/@boilerplate]
[/@file]
[/#if]
[#macro processWsdl wsdl]
[@file name="soap_" + wsdl.@namespaceId + ".html" charset="utf-8"]
[@boilerplate title="SOAP: " + wsdl.@namespaceId subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "SOAP" , "href" : "soap.html", "subnav" : nav_sections }, { "title" : wsdl.@namespaceId?string , "href" : "soap_" + wsdl.@namespaceId + ".html" }]]
<h1>${wsdl.@namespaceId}</h1>
<table>
<tr>
<td align="right">Namespace URI:</td>
<td>[#if wsdl.@namespace?length > 0]${wsdl.@namespace}[#else](default namespace)[/#if]</td>
</tr>
[#if attributeExists(wsdl.@file)]
<tr>
<td align="right">WSDL:</td>
<td><a href="${wsdl.@file}">${wsdl.@file}</a></td>
</tr>
[/#if]
</table>
<h3>Endpoints</h3>
<ul>
[#list wsdl.endpointInterface?sort_by("@name") as endpointInterface]
<li[#if isDeprecated(endpointInterface)] class="deprecated"[/#if]><a href="soap_${wsdl.@namespaceId}_${endpointInterface.@name}.html">${endpointInterface.@name}</a></li>
[/#list]
</ul>
[/@boilerplate]
[/@file]
[/#macro]
[#macro processResourceGroup group]
[@file name="resource_" + group + ".html" charset="utf-8"]
[@boilerplate title=group subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "REST" , "href" : "rest.html", "subnav" : nav_sections}, {"title" : group , "href" : "resource_" + group + ".html", "subnav" : nav_resource_groups}]]
<h1>${group}</h1>
[#assign resources=[] /]
[#list docsxml.rest.resources.resource as resource]
[#list resource.groups.group as rg]
[#if rg = group]
[#assign resources=resources + resource /]
[#break/]
[/#if]
[/#list]
[/#list]
<p>The following resources are part of this group:</p>
<ul>
[#list resources as resource]
<li><a href="#${scrubPathToFilename(resource.@name)}">${resource.@name}</a></li>
[/#list]
</ul>
[#list resources as resource]
<a name="${scrubPathToFilename(resource.@name)}"></a>
[@processRawResource resource=resource/]
[/#list]
[/@boilerplate]
[/@file]
[/#macro]
[#macro processResource resource]
[#assign resource_filename=scrubPathToFilename(resource.@name)/]
[@file name=resource_filename charset="utf-8"]
[@boilerplate title=group subnav=[{"title" : "Home", "href" : indexPageName}, { "title" : "REST" , "href" : "rest.html", "subnav" : nav_sections }, {"title" : resource.@name , "href" : resource_filename, "subnav" : nav_paths}]]
[@processRawResource resource=resource/]
[/@boilerplate]
[/@file]
[/#macro]
[#macro processRawResource resource]
<h1>${resource.@name}</h1>
[#if attributeExists(resource.@subcontext) && !disableRestMountpoint!false]
<p class="note">Mount Point: <a href="${apiRelativePath}${resource.@subcontext}${resource.@name}">${resource.@subcontext}${resource.@name}</a></p>
[/#if]
[#if tocNeeded(resource.operation)]
<p>
The following operations are supported on this resource:
</p>
<ul>
[#list resource.operation as operation]
<li[#if isDeprecated(operation)] class="deprecated"[/#if]><a href="#${operation.@name}">${operation.@name}</a></li>
[#list operation.alias as alias]
<li[#if isDeprecated(operation)] class="deprecated"[/#if]><a href="#${operation.@name}">${alias}</a></li>
[/#list]
[/#list]
</ul>
[/#if]
[#list resource.operation as operation]
<a name="${operation.@name}"></a>
<h2>${operation.@name}</h2>
[#list operation.alias as alias]
<p class="note">Alias: ${alias}</p>
[/#list]
[#if isDeprecated(operation)]
<p class="alert">This operation has been deprecated. [#list operation.tag as tag][#if tag.@name="deprecated"] ${tag}[/#if][/#list]</p>
[/#if]
[#list operation.documentation as documentation]
<p>${documentation}</p>
[/#list]
[#list operation.parameter as parameter]
[#if parameter_index = 0]
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
[/#if]
<tr>
<td>[#if attributeExists(parameter.@name)]${parameter.@name}[/#if]</td>
<td>${parameter}</td>
<td>[#if attributeExists(parameter.@type)]${parameter.@type}[/#if]</td>
<td>[#if attributeExists(parameter.@defaultValue)]${parameter.@defaultValue}[/#if]</td>
</tr>
[#if !parameter_has_next]
</table>
[/#if]
[/#list]
[#list operation.inValue as inValue]
<h3>Request Body</h3>
<table>
[#assign custom=true]
[#list inValue.xmlElement as xmlElement]
[#if attributeExists(xmlElement.@elementName)]
[#assign custom=false/]
<tr>
<td align="right">element:</td>
[#if attributeExists(xmlElement.@elementSchemaId)]
<td><a href="el_${xmlElement.@elementSchemaId}_${xmlElement.@elementName}.html">${xmlElement.@elementName}</a></td>
[#else]
<td>${xmlElement.@elementName}</td>
[/#if]
</tr>
[/#if]
[/#list]
[#list inValue.jsonElement as jsonElement]
[#if attributeExists(jsonElement.@elementName)]
[#assign custom=false/]
<tr>
<td align="right">element:</td>
[#if attributeExists(jsonElement.@elementSchemaId)]
<td><a href="json_${jsonElement.@elementSchemaId}_${jsonElement.@elementName}.html">${jsonElement.@elementName}</a></td>
[#else]
<td>${jsonElement.@elementName}</td>
[/#if]
</tr>
[/#if]
[/#list]
[#if custom]
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
[/#if]
[#list inValue["contentType[consumable='true']"] as contentType]
<tr>
<td align="right">consumable media type:</td>
<td>${contentType.@type}</td>
</tr>
[/#list]
</table>
[#list inValue.documentation as documentation]
<p>${documentation}</p>
[/#list]
[/#list]
[#list operation.outValue as outValue]
<h3>Response Body</h3>
<table>
[#assign custom=true]
[#list outValue.xmlElement as xmlElement]
[#if attributeExists(xmlElement.@elementName)]
[#assign custom=false/]
<tr>
<td align="right">element:</td>
[#if attributeExists(xmlElement.@elementSchemaId)]
<td><a href="el_${xmlElement.@elementSchemaId}_${xmlElement.@elementName}.html">${xmlElement.@elementName}</a></td>
[#else]
<td>${xmlElement.@elementName}</td>
[/#if]
</tr>
[/#if]
[/#list]
[#list outValue.jsonElement as jsonElement]
[#if attributeExists(jsonElement.@elementName)]
[#assign custom=false/]
<tr>
<td align="right">element:</td>
[#if attributeExists(jsonElement.@elementSchemaId)]
<td><a href="json_${jsonElement.@elementSchemaId}_${jsonElement.@elementName}.html">${jsonElement.@elementName}</a></td>
[#else]
<td>${jsonElement.@elementName}</td>
[/#if]
</tr>
[/#if]
[/#list]
[#if custom]
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
[/#if]
[#list outValue["contentType[produceable='true']"] as contentType]
<tr>
<td align="right">produceable media type:</td>
<td>${contentType.@type}</td>
</tr>
[/#list]
</table>
[#list outValue.documentation as documentation]
<p>${documentation}</p>
[/#list]
[/#list]
[#list operation.statusCode as statusCode]
[#if statusCode_index = 0]
<h3>Status Codes</h3>
<table>
<tr>
<th>code</th>
<th>description</th>
</tr>
[/#if]
<tr>
<td>${statusCode.@code}</td>
<td>${statusCode}</td>
</tr>
[#if !statusCode_has_next]
</table>
[/#if]
[/#list]
[/#list]
[/#macro]
[#macro processEndpointInterface endpointInterface]
[@file name="soap_" + endpointInterface?parent.@namespaceId + "_" + endpointInterface.@name + ".html" charset="utf-8"]
[@boilerplate title=endpointInterface.@name subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "SOAP" , "href" : "soap.html", "subnav" : nav_sections }, {"title" : endpointInterface?parent.@namespaceId , "href" : "soap_" + endpointInterface?parent.@namespaceId + ".html", "subnav" : nav_wsdls }, {"title" : endpointInterface.@name , "href" : "soap_" + endpointInterface.@name + ".html", "subnav" : nav_eis_by_ns[endpointInterface?parent.@namespaceId?string]}]]
<h1>${endpointInterface.@name}</h1>
[#if isDeprecated(endpointInterface)]
<p class="alert">This endpoint has been deprecated.[#list endpointInterface.tag as tag][#if tag.@name="deprecated"] ${tag}[/#if][/#list]</p>
[/#if]
<table>
<tr>
<td align="right">Namespace:</td>
<td>[#if (endpointInterface?parent).@namespace?length > 0]${(endpointInterface?parent).@namespace}[#else](default namespace)[/#if]</td>
</tr>
[#if attributeExists((endpointInterface?parent).@file)]
<tr>
<td align="right">WSDL:</td>
<td><a href="${(endpointInterface?parent).@file}">${(endpointInterface?parent).@file}</a></td>
</tr>
[/#if]
[#if attributeExists(endpointInterface.@path)]
<tr>
<td align="right">Path:</td>
<td><a href="${apiRelativePath}${endpointInterface.@path}">${endpointInterface.@path}</a></td>
</tr>
[/#if]
</table>
[#if endpointInterface.documentation?size > 0]
[#list endpointInterface.documentation as documentation]
<p>${documentation}</p>
[/#list]
[/#if]
[#if tocNeeded(endpointInterface.method)]
<p>
The following methods are available on this endpoint:
</p>
<ul>
[#list endpointInterface.method as method]
<li[#if isDeprecated(method)] class="deprecated"[/#if]><a href="#${method.@name}">${method.@name}</a></li>
[/#list]
</ul>
[/#if]
[#list endpointInterface.method as method]
<a name="${method.@name}"></a>
<h2>${method.@name}</h2>
[#if isDeprecated(method)]
<p class="alert">This method has been deprecated.[#list method.tag as tag][#if tag.@name="deprecated"] ${tag}[/#if][/#list]</p>
[/#if]
[#list method.documentation as documentation]
<p>${documentation}</p>
[/#list]
[#list method["parameter[@input='true']"] as parameter]
[#if parameter_index = 0]
<h3>Input Parameters</h3>
<table>
<tr>
<th>name</th>
<!--todo: add the parameter type and whether its a collection-->
<th>description</th>
</tr>
[/#if]
<tr>
<td>${parameter.@name}</td>
<td>${parameter}</td>
</tr>
[#if !parameter_has_next]
</table>
[/#if]
[/#list]
[#list method["parameter[@output='true']"] as parameter]
[#if parameter_index = 0]
<h3>Output Parameters</h3>
<table>
<tr>
<th>name</th>
<!--todo: add the parameter type and whether its a collection-->
<th>description</th>
</tr>
[/#if]
<tr>
<td>${parameter.@name}</td>
<td>${parameter}</td>
</tr>
[#if !parameter_has_next]
</table>
[/#if]
[/#list]
[#list method.result as result]
<h3>Return Value</h3>
<p>${result}</p>
[/#list]
[#list method.fault as fault]
[#if fault_index = 0]
<h3>Faults</h3>
<table>
<tr>
<th>name</th>
<!--todo: add the parameter type and whether its a collection-->
<th>description</th>
</tr>
[/#if]
<tr>
<td>${fault.@name}</td>
<td>${fault}</td>
</tr>
[#if !fault_has_next]
</table>
[/#if]
[/#list]
[/#list]
[/@boilerplate]
[/@file]
[/#macro]
[#macro processSchema schema]
[@file name=schema.@namespaceId + ".html" charset="utf-8"]
[@boilerplate title="Namespace" subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "Data Model" , "href" : "model.html", "subnav" : nav_sections}, {"title" : schema.@namespaceId , "href" : schema.@namespaceId + ".html", "subnav" : nav_models}]]
[#if schema.elements.element?size > 0]
<h2>Elements</h2>
<ul>
[#list schema.elements.element?sort_by("@name") as element]
[@processElement element=element/]
<li[#if isDeprecated(element)] class="deprecated"[/#if]><a href="el_${schema.@namespaceId}_${element.@name}.html">${element.@name}</a></li>
[/#list]
</ul>
[/#if]
[#if schema.types.type?size > 0]
<h2>Types</h2>
<ul>
[#list schema.types.type?sort_by("@name") as type]
[@processType type=type/]
<li[#if isDeprecated(type)] class="deprecated"[/#if]><a href="${schema.@namespaceId}_${type.@name}.html">${type.@name}</a></li>
[/#list]
</ul>
[/#if]
[/@boilerplate]
[/@file]
[/#macro]
[#macro processElement element]
[#assign schema=element?parent?parent/]
[@file name="el_" + schema.@namespaceId + "_" + element.@name + ".html" charset="utf-8"]
[@boilerplate title=element.@name subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "Data Model" , "href" : "model.html", "subnav" : nav_sections}, {"title" : schema.@namespaceId , "href" : schema.@namespaceId + ".html", "subnav" : nav_models}, {"title" : element.@name + " element" , "href" : "el_" + schema.@namespaceId + "_" + element.@name + ".html", "subnav" : nav_elements_by_ns[schema.@namespaceId?string]}] codeblocks=true]
<h1>${element.@name} element</h1>
[#if isDeprecated(element)]
<p class="alert">This element has been deprecated.[#list element.tag as tag][#if tag.@name="deprecated"] ${tag}[/#if][/#list]</p>
[/#if]
<table>
[#if attributeExists(element.@typeName) && attributeExists(element.@typeSchemaId)]
<tr>
<td align="right">Type:</td>
<td><a href="${element.@typeSchemaId}_${element.@typeName}.html">${element.@typeName}</a></td>
</tr>
[/#if]
</table>
[#list element.documentation as documentation]
<p>${documentation}</p>
[/#list]
[#list element.examplexml as examplexml]
<h2>Example XML</h2>
<code class="prettyprint lang-xml">${examplexml?string?xhtml}</code>
[/#list]
[#list element.examplejson as examplejson]
<h2>Example JSON</h2>
<code class="prettyprint lang-js">${examplejson?string?xhtml}</code>
[/#list]
[/@boilerplate]
[/@file]
[/#macro]
[#macro processType type]
[#assign schema=type?parent?parent/]
[@file name=schema.@namespaceId + "_" + type.@name + ".html" charset="utf-8"]
[@boilerplate title=type.@name subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "Data Model" , "href" : "model.html", "subnav" : nav_sections}, {"title" : schema.@namespaceId , "href" : schema.@namespaceId + ".html", "subnav" : nav_models} , {"title" : type.@name , "href" : schema.@namespaceId + "_" + type.@name + ".html", "subnav" : nav_typedefs_by_ns[schema.@namespaceId?string]}] codeblocks=true]
<h1>${type.@name}</h1>
[#if isDeprecated(type)]
<p class="alert">This type has been deprecated.[#list type.tag as tag][#if tag.@name="deprecated"] ${tag}[/#if][/#list]</p>
[/#if]
<table>
[#if attributeExists(type.@extendsType)]
[#list docsxml.data.schema.types.type as candidate]
[#if attributeExists(candidate.@id) && (candidate.@id?string = type.@extendsType?string)]
<tr>
<td align="right">Extends:</td>
<td><a href="${candidate?parent?parent.@namespaceId}_${candidate.@name}.html">${candidate.@name}</a></td>
</tr>
[#break/]
[/#if]
[/#list]
[/#if]
</table>
[#list type.documentation as documentation]
<p>${documentation}</p>
[/#list]
[#if type.values.item?size > 0]
[#list type.values.item as value]
[#if value_index = 0]
<h2>Possible Values</h2>
<table>
<tr>
<th>value</th>
<th>description</th>
</tr>
[/#if]
<tr>
<td[#if isDeprecated(value)] class="deprecated"[/#if]>${value.@value}</td>
<td>
[#list value.documentation as documentation]
${documentation}
[/#list]
</td>
</tr>
[#if !value_has_next]
</table>
[/#if]
[/#list]
[#else]
<h2>JSON</h2>
<table>
<tr>
<th>property</th>
<th>type</th>
<th>description</th>
</tr>
[#list type.attributes.attribute as attribute]
<tr>
<td>[#if attributeExists(attribute.@jsonName)]${attribute.@jsonName}[/#if]</td>
<td>[#if attributeExists(attribute.@typeSchemaId)][#if attributeExists(attribute.@typeName)][#assign typename=attribute.@typeName/][#else][#assign typename="(anonymous)"/][/#if]<a href="${attribute.@typeSchemaId}_${typename}.html">${typename}</a>[#elseif attributeExists(attribute.@typeName)]${attribute.@typeName}[/#if]</td>
<td>${attribute}</td>
</tr>
[/#list]
[#list type.elements.element as element]
<tr>
<td>[#if attributeExists(element.@jsonName)]${element.@jsonName}[/#if]</td>
<td>
[#list element.choice as choice]
[#if element.@maxOccurs = "unbounded"]array of [/#if][#if choice_index > 0]<br/>or [/#if][#if attributeExists(choice.@schemaId)]<a href="el_${choice.@schemaId}_${choice.@name}.html">${choice.@name}</a>[#else]${choice.@name}[/#if][#if attributeExists(choice.@typeSchemaId)][#if attributeExists(choice.@typeName)][#assign typename=choice.@typeName/][#else][#assign typename="(anonymous)"/][/#if] (<a href="${choice.@typeSchemaId}_${typename}.html">${typename}</a>)[#elseif attributeExists(choice.@typeName)] (${choice.@typeName})[/#if]
[/#list]
</td>
<td>
[#list element.documentation as documentation]
${documentation}
[/#list]
</td>
</tr>
[/#list]
[#list type.value as value]
<tr>
<td>[#if attributeExists(value.@jsonName)]${value.@jsonName}[/#if]</td>
<td>[#if attributeExists(value.@typeSchemaId)][#if attributeExists(value.@typeName)][#assign typename=value.@typeName/][#else][#assign typename="(anonymous)"/][/#if]<a href="${value.@typeSchemaId}_${typename}.html">${typename}</a>[#elseif attributeExists(value.@typeName)]${value.@typeName}[/#if]</td>
<td>${value}</td>
</tr>
[/#list]
</table>
[/#if]
[/@boilerplate]
[/@file]
[/#macro]
[#macro processJsonType type]
[@file name="json_" + type?parent.@schemaId + "_" + type.@name + ".html" charset="utf-8"]
[@boilerplate title=type.@name subnav=[{"title" : "Home", "href" : indexPageName}, {"title" : "JSON" , "href" : "#"}, {"title" : type.@name , "href" : "json_" + type?parent.@schemaId + "_" + type.@name + ".html"}] codeblocks=true]
<h1>${type.@name}</h1>
<table>
[#if attributeExists(type?parent.@schemaId)]
<tr>
<td align="right">JSON Schema ID:</td>
<td>${type?parent.@schemaId}</td>
</tr>
[/#if]
[#if attributeExists(type?parent.@file)]
<tr>
<td align="right">JSON Schema File:</td>
<td><a href="${type?parent.@file}">${type?parent.@file}</a></td>
</tr>
[/#if]
</table>