source: MDRepository/trunk/docs/MDRepository.wadl

<?xml version="1.0" encoding="UTF-8"?>
<application
    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/"
>
<doc title="CLARIN Metadata Repository" >
This is a draft description of the REST-interface of <code>CLARIN Metadata Repository</code>. Especially the response description is very sketchy yet.
</doc>
    
    <resources base="http://cmdi.clarin.eu/mdrepository/">
                                
                                
                                <resource id="collections" path="">
                                        <doc title="Collections summary" >
                                                This interface provides summary of the basic collections hierarchy in which the MdRecords are organised
                                                </doc>

            <method name="GET">
                <request>   
                                <param name="operation" type="xs:string" fixed="getCollections" style="query">                        
                    </param>                 
                    <param name="collection" type="xs:URI" style="query" default="root">                        
                                <doc>handles identifying the examined collection</doc>                       
                    </param>                    
                    <param name="maxdepth" type="xs:integer" default="1" style="query">
                        <doc>how deep in the collection hierarchy tree to go</doc>                       
                    </param>
                </request>
                <response>
                                <representation mediaType="text/xml" element="mds:Collections">
                        <param name="collection_name" path="//Collection" repeating="true" type="xs:QName" style="plain">
                            <link resource_type="#collection"/>
                        </param>                        
                    </representation>                    
                </response>
            </method>
        </resource>
        
        <resource id="model" path="">
                <doc title="Model summary" >
                                                This interface provides summary of the xml structures used in the MdRecords
                                                </doc>

            <method name="GET">
                <request>   
                                <param name="operation" type="xs:string" fixed="queryModel" style="query">                        
                    </param>                 
                    <param name="q" type="xpath:XPath" style="query" >                        
                        <doc>just default simple paths: Components/olac</doc>
                    </param>
                    <param name="collection" type="xs:URI" style="query" default="root"> 
                                <doc>handles identifying the collection</doc>                       
                    </param>                    
                    <param name="maxdepth" type="xs:integer" default="1" style="query"/>
                </request>
                <response>
                    <representation mediaType="text/xml" element="mds:Terms">
                        <param name="cmdIndex" path="//mds:Terms/@path" repeating="true" type="xs:anyURI" style="plain">                           
                        </param>
                    </representation>                    
                    
                </response>
            </method>
        </resource>
        
        <resource id="search" path="">
                <doc title="Search interface" >
                                                This interface provides actual search-functionality. The query-format is XPath, the result is based on SRU/CQL standard (<code>searchRetrieveResponse</code>), individual records are full MDRecords (root elem: <code>CMD</code>).
                                                </doc>

            <method name="GET">
                <request>   
                                <param name="operation" type="xs:string" fixed="searchRetrieve" style="query">                        
                    </param>                 
                    <param name="query" type="xpath:XPath" style="query" />                        
                    <param name="collection" type="xs:URI" style="query" default="root"/>                                            
                    <param name="startRecord" type="xs:integer" default="1" style="query"/>
                    <param name="maximumRecords" type="xs:integer" default="50" style="query"/>
                </request>
                <response>
                    <representation mediaType="text/xml" element="mds:searchRetrieveResponse">
                        <param name="records" path="//records/record/CMD" repeating="false" type="xs:anyURI" style="plain">                           
                        </param>
                    </representation>                                        
                    
                </response>
            </method>
        </resource>
    </resources>            
    
</application>