source: MDRepository/trunk/docs/MDRepository.wadl.html

Last change on this file was 852, checked in by vronk, 14 years ago

starting docs-folder for MDRepository
with first version of WADL for MDRepository
File size: 15.7 KB
Line 
1<!DOCTYPE html
2  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4   <head>
5      <title>CLARIN Metadata Repository</title><style type="text/css">
6                    body {
7                        font-family: sans-serif;
8                        font-size: 1em;
9                        margin: 2em 8em;
10                    }
11                    .methods {
12                        background-color: #eef;
13                        padding: 1em;
14                    }
15                    h1 {
16                        font-size: 1.6em;
17                    }
18                    h2 {
19                        border-bottom: 1px solid black;
20                        /* margin-top: 0.6em;
21                        margin-bottom: 0.2em; */
22                        font-size: 1.4em;
23                       }
24                    h3 {
25                        color: orange;
26                        font-size: 1.2em;
27                        margin-top: 0.5em;
28                        margin-bottom: 0em;
29                    }
30                    h4 {
31                        margin: 0em;
32                        padding: 0em;
33                        border-bottom: 2px solid white;
34                    }
35                    h6 {
36                        font-size: 1.1em;
37                        color: #99a;
38                        margin: 0.5em 0em 0.25em 0em;
39                    }
40                    dd {
41                        margin-left: 1em;
42                    }
43                    tt {
44                        font-size: 1.2em;
45                    }
46                    table {
47                        margin-bottom: 0.5em;
48                    }
49                    th {
50                        text-align: left;
51                        font-weight: normal;
52                        color: black;
53                        border-bottom: 1px solid black;
54                        padding: 3px 6px;
55                    }
56                    td {
57                        padding: 3px 6px;
58                        vertical-align: top;
59                        background-color: f6f6ff;
60                        font-size: 0.85em;
61                    }
62                   
63                    td p {
64                        margin: 0px;
65                    }
66                    ul {
67                        padding-left: 1.75em;
68                    }
69                    p + ul, p + ol, p + dl {
70                        margin-top: 0em;
71                    }
72                    .optional {
73                        font-weight: normal;
74                        opacity: 0.75;
75                    }
76                    /* additions */
77                    p { margin: 0.4em 0; }
78                    .resource {margin-top: 1em;
79                </style></head>
80   <body>
81      <h1>CLARIN Metadata Repository</h1>
82      <p>
83         This is a draft description of the REST-interface of <code xmlns="http://research.sun.com/wadl/2006/10" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xpath="http://www.w3.org/TR/xpath20/" xmlns:cat="http://www.isocat.org/" xmlns:dcif="http://www.isocat.org/ns/dcif" xmlns:mds="http://cmdi.clarin.eu/mdservice/">CLARIN Metadata Repository</code>. Especially the response description is very sketchy yet.
84         
85      </p>
86      <ul>
87         <li><a href="#resources">Resources</a><ul>
88               <li><a href="#http://cmdi.clarin.eu/mdrepository#collections">http://cmdi.clarin.eu/mdrepository/</a></li>
89               <li><a href="#http://cmdi.clarin.eu/mdrepository#model">http://cmdi.clarin.eu/mdrepository/</a></li>
90               <li><a href="#http://cmdi.clarin.eu/mdrepository#search">http://cmdi.clarin.eu/mdrepository/</a></li>
91            </ul>
92         </li>
93         <li><a href="#representations">Representations</a><ul>
94               <li><a href="#d2e30">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} Collections">mds:Collections</abbr>)</a></li>
95               <li><a href="#d2e70">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} Terms">mds:Terms</abbr>)</a></li>
96               <li><a href="#d2e108">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} searchRetrieveResponse">mds:searchRetrieveResponse</abbr>)</a></li>
97            </ul>
98         </li>
99      </ul>
100      <h2 id="resources">Resources</h2>
101      <div class="resource">
102         <h4 id="http://cmdi.clarin.eu/mdrepository#collections">Collections summary</h4>
103         <h3>/?operation&amp;collection&amp;maxdepth</h3>
104         <p>
105                                                        This interface provides summary of the basic collections hierarchy in which the MdRecords are organised
106                                                       
107         </p>
108         <h6>Methods</h6>
109         <div class="methods">
110            <div class="method">
111               <h4 id="d2e8">GET</h4>
112               <h6>request query parameters</h6>
113               <table>
114                  <tr>
115                     <th>parameter</th>
116                     <th>value</th>
117                     <th>description</th>
118                  </tr>
119                  <tr>
120                     <td>
121                        <p><strong>operation</strong></p>
122                     </td>
123                     <td>
124                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#string">string</a></em></p>
125                        <p>Fixed: <tt>getCollections</tt></p>
126                     </td>
127                     <td></td>
128                  </tr>
129                  <tr>
130                     <td>
131                        <p><strong>collection</strong></p>
132                     </td>
133                     <td>
134                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#URI">URI</a></em></p>
135                        <p>Default: <tt>root</tt></p>
136                     </td>
137                     <td>
138                        <p>handles identifying the examined collection</p>
139                     </td>
140                  </tr>
141                  <tr>
142                     <td>
143                        <p><strong>maxdepth</strong></p>
144                     </td>
145                     <td>
146                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#integer">integer</a></em></p>
147                        <p>Default: <tt>1</tt></p>
148                     </td>
149                     <td>
150                        <p>how deep in the collection hierarchy tree to go</p>
151                     </td>
152                  </tr>
153               </table>
154               <p><em>available response representations:</em></p>
155               <ul>
156                  <li><a href="#d2e30">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} Collections">mds:Collections</abbr>)</a></li>
157               </ul>
158            </div>
159         </div>
160      </div>
161      <div class="resource">
162         <h4 id="http://cmdi.clarin.eu/mdrepository#model">Model summary</h4>
163         <h3>/?operation&amp;q&amp;collection&amp;maxdepth</h3>
164         <p>
165                                                        This interface provides summary of the xml structures used in the MdRecords
166                                                       
167         </p>
168         <h6>Methods</h6>
169         <div class="methods">
170            <div class="method">
171               <h4 id="d2e46">GET</h4>
172               <h6>request query parameters</h6>
173               <table>
174                  <tr>
175                     <th>parameter</th>
176                     <th>value</th>
177                     <th>description</th>
178                  </tr>
179                  <tr>
180                     <td>
181                        <p><strong>operation</strong></p>
182                     </td>
183                     <td>
184                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#string">string</a></em></p>
185                        <p>Fixed: <tt>queryModel</tt></p>
186                     </td>
187                     <td></td>
188                  </tr>
189                  <tr>
190                     <td>
191                        <p><strong>q</strong></p>
192                     </td>
193                     <td>
194                        <p><em><a href="" title="">XPath</a></em></p>
195                     </td>
196                     <td>
197                        <p>just default simple paths: Components/olac</p>
198                     </td>
199                  </tr>
200                  <tr>
201                     <td>
202                        <p><strong>collection</strong></p>
203                     </td>
204                     <td>
205                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#URI">URI</a></em></p>
206                        <p>Default: <tt>root</tt></p>
207                     </td>
208                     <td>
209                        <p>handles identifying the collection</p>
210                     </td>
211                  </tr>
212                  <tr>
213                     <td>
214                        <p><strong>maxdepth</strong></p>
215                     </td>
216                     <td>
217                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#integer">integer</a></em></p>
218                        <p>Default: <tt>1</tt></p>
219                     </td>
220                     <td></td>
221                  </tr>
222               </table>
223               <p><em>available response representations:</em></p>
224               <ul>
225                  <li><a href="#d2e70">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} Terms">mds:Terms</abbr>)</a></li>
226               </ul>
227            </div>
228         </div>
229      </div>
230      <div class="resource">
231         <h4 id="http://cmdi.clarin.eu/mdrepository#search">Search interface</h4>
232         <h3>/?operation&amp;query&amp;collection&amp;startRecord&amp;maximumRecords</h3>
233         <p>
234                                                        This interface provides actual search-functionality. The query-format is XPath, the result is based on SRU/CQL standard
235            (<code xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xpath="http://www.w3.org/TR/xpath20/" xmlns:cat="http://www.isocat.org/" xmlns:dcif="http://www.isocat.org/ns/dcif" xmlns:mds="http://cmdi.clarin.eu/mdservice/" xmlns="http://research.sun.com/wadl/2006/10" xmlns:ns="urn:namespace">searchRetrieveResponse</code>), individual records are full MDRecords (root elem: <code xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xpath="http://www.w3.org/TR/xpath20/" xmlns:cat="http://www.isocat.org/" xmlns:dcif="http://www.isocat.org/ns/dcif" xmlns:mds="http://cmdi.clarin.eu/mdservice/" xmlns="http://research.sun.com/wadl/2006/10" xmlns:ns="urn:namespace">CMD</code>).
236                                                       
237         </p>
238         <h6>Methods</h6>
239         <div class="methods">
240            <div class="method">
241               <h4 id="d2e90">GET</h4>
242               <h6>request query parameters</h6>
243               <table>
244                  <tr>
245                     <th>parameter</th>
246                     <th>value</th>
247                     <th>description</th>
248                  </tr>
249                  <tr>
250                     <td>
251                        <p><strong>operation</strong></p>
252                     </td>
253                     <td>
254                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#string">string</a></em></p>
255                        <p>Fixed: <tt>searchRetrieve</tt></p>
256                     </td>
257                     <td></td>
258                  </tr>
259                  <tr>
260                     <td>
261                        <p><strong>query</strong></p>
262                     </td>
263                     <td>
264                        <p><em><a href="" title="">XPath</a></em></p>
265                     </td>
266                     <td></td>
267                  </tr>
268                  <tr>
269                     <td>
270                        <p><strong>collection</strong></p>
271                     </td>
272                     <td>
273                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#URI">URI</a></em></p>
274                        <p>Default: <tt>root</tt></p>
275                     </td>
276                     <td></td>
277                  </tr>
278                  <tr>
279                     <td>
280                        <p><strong>startRecord</strong></p>
281                     </td>
282                     <td>
283                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#integer">integer</a></em></p>
284                        <p>Default: <tt>1</tt></p>
285                     </td>
286                     <td></td>
287                  </tr>
288                  <tr>
289                     <td>
290                        <p><strong>maximumRecords</strong></p>
291                     </td>
292                     <td>
293                        <p><em><a href="http://www.w3.org/TR/xmlschema-2/#integer">integer</a></em></p>
294                        <p>Default: <tt>50</tt></p>
295                     </td>
296                     <td></td>
297                  </tr>
298               </table>
299               <p><em>available response representations:</em></p>
300               <ul>
301                  <li><a href="#d2e108">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} searchRetrieveResponse">mds:searchRetrieveResponse</abbr>)</a></li>
302               </ul>
303            </div>
304         </div>
305      </div>
306      <h2 id="representations">Representations</h2>
307      <h3 id="d2e30">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} Collections">mds:Collections</abbr>)
308      </h3>
309      <div class="representation">
310         <h6>XML Schema</h6>
311         <p><em>Source: <a href=""></a></em></p><pre></pre><h6> plain parameters</h6>
312         <table>
313            <tr>
314               <th>parameter</th>
315               <th>value</th>
316               <th>description</th>
317            </tr>
318            <tr>
319               <td>
320                  <p><strong>collection_name</strong></p>
321               </td>
322               <td>
323                  <p><em><a href="http://www.w3.org/TR/xmlschema-2/#QName">QName</a></em><small> (repeating)</small></p>
324               </td>
325               <td>
326                  <ul>
327                     <li>XPath to value: <tt>//Collection</tt></li>
328                     <li>
329                        Link: <a href="##collection"></a></li>
330                  </ul>
331               </td>
332            </tr>
333         </table>
334      </div>
335      <h3 id="d2e70">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} Terms">mds:Terms</abbr>)
336      </h3>
337      <div class="representation">
338         <h6>XML Schema</h6>
339         <p><em>Source: <a href=""></a></em></p><pre></pre><h6> plain parameters</h6>
340         <table>
341            <tr>
342               <th>parameter</th>
343               <th>value</th>
344               <th>description</th>
345            </tr>
346            <tr>
347               <td>
348                  <p><strong>cmdIndex</strong></p>
349               </td>
350               <td>
351                  <p><em><a href="http://www.w3.org/TR/xmlschema-2/#anyURI">anyURI</a></em><small> (repeating)</small></p>
352               </td>
353               <td>
354                  <ul>
355                     <li>XPath to value: <tt>//mds:Terms/@path</tt></li>
356                  </ul>
357               </td>
358            </tr>
359         </table>
360      </div>
361      <h3 id="d2e108">text/xml (<abbr title="{http://cmdi.clarin.eu/mdservice/} searchRetrieveResponse">mds:searchRetrieveResponse</abbr>)
362      </h3>
363      <div class="representation">
364         <h6>XML Schema</h6>
365         <p><em>Source: <a href=""></a></em></p><pre></pre><h6> plain parameters</h6>
366         <table>
367            <tr>
368               <th>parameter</th>
369               <th>value</th>
370               <th>description</th>
371            </tr>
372            <tr>
373               <td>
374                  <p><strong>records</strong></p>
375               </td>
376               <td>
377                  <p><em><a href="http://www.w3.org/TR/xmlschema-2/#anyURI">anyURI</a></em></p>
378               </td>
379               <td>
380                  <ul>
381                     <li>XPath to value: <tt>//records/record/CMD</tt></li>
382                  </ul>
383               </td>
384            </tr>
385         </table>
386      </div>
387   </body>
388</html>
Note: See TracBrowser for help on using the repository browser.