ui.restdocs.template.xhtml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencast-common Show documentation
There is a newer version: 16.6



  
  

  ${meta.title} REST Documentation
  



  
  
  


${meta.title} REST Documentation


  
    ${meta.url}
    ${(meta.abstract)!}
  





<#list notes>
General Notes

  <#items as note>
  ${note}
  





Table of Contents

  <#list endpointHolders as endpointHolder>
  <#list endpointHolder.endpoints as endpoint>
  ${endpoint.method} ${endpoint.path}
  
  




<#list endpointHolders as endpointHolder>
<#list endpointHolder.endpoints>
${endpointHolder.title} methods
<#items as endpoint>

    <#if (endpoint.requiredParams?size > 0)>
    
    <#if endpoint.bodyParam??>
    
    <#if (endpoint.formats?size > 0)>
    
    <#if (endpoint.returnTypeSchema??)>
      
    <#if (endpoint.notes?size > 0)>
    
  
    
      Method / Path:
      ${endpoint.method} ${endpoint.path}
    
  
  
    
      Description:
      ${endpoint.description!"NONE"}
    
    
      Path params:
      
        <#list endpoint.pathParams as param>
        ${param.name}<#if param.defaultValue??>(Default value=${param.escapedDefaultValue}):
        ${param.description!"NONE"}<#sep>

        <#else>
        NONE
        
      
    

      Required (form) params:
      
        <#list endpoint.requiredParams as param>
        
          ${param.name}: ${param.description!""}
          <#if param.xmlSchema??>
            
              XML Schema
              
                <#if param.escapedXmlSchema??>${param.escapedXmlSchema}

              
              Hide
            
          
        <#if param_has_next> 

        
      
    
    
      Body (upload) param:
      
        <#if endpoint.bodyParam.defaultValue??>
        (Default value=${endpoint.bodyParam.escapedDefaultValue}):
        ${endpoint.bodyParam.description!"NONE"}
      
    
    
    
      Optional (<#if (endpoint.method == "GET" || endpoint.method == "DELETE")>query<#else>form) params:
      
        <#list endpoint.optionalParams as param>
        ${param.name}<#if param.defaultValue??>(Default value=${param.escapedDefaultValue}):
        ${param.description!"NONE"}<#sep> 

        <#else>
        NONE
        
      
    

      Response formats:
      
        <#list endpoint.formats as format>
        <#if format.url??>${format.name}<#else>${format.name}
        <#if format.description??>(${format.description})<#sep>

        
      
    
    
    
      Status codes:
      
        <#list endpoint.statuses as status>
        ${status.code}: ${status.name}, ${status.description!"NONE"}<#if status_has_next> 

        <#else>
        NONE
        
      
    

        Returned Entity Schema:
        
          
            Click to view
            
              <#if endpoint.escapedReturnTypeSchema??>${endpoint.escapedReturnTypeSchema}

            
            Hide
          
        
      
    
      Notes:
      
        
          <#list endpoint.notes as note>
          ${note}
          
        
      
    
    
    
      Testing:
      
        Sample:
        ${endpoint.path}${endpoint.queryString!}
        
        <#if endpoint.form??>
        <#if (endpoint.form.basic)><#-- link to the basic endpoint path -->
        ${meta.url}${endpoint.path}${endpoint.queryString!}
        <#else>
        Testing form (click to reveal)
        
           enctype="multipart/form-data">
            
            
            
            <#if (endpoint.form.ajaxSubmit)>
            
            
            
                Form action: ${meta.url}${endpoint.path}
            
            
              <#list endpoint.form.items as item>
              
                <#if item.type == "text">
                
                <#elseif item.type == "boolean">
                
                <#elseif item.type == "file">
                
                <#else>
                
                  ${item.name}:

                  8<#else>3</#if></#if>"
                            cols="${(item.attributes.cols)!'80'}">${item.defaultValue!}
                  ${item.description!}
                
                  <#if item.required>* ${item.name}:
                
                
                  checked />
                
                ${item.description!} 
                  <#if item.required>* ${item.name}:
                
                
                  
                
                ${item.description!} 
                  <#if item.required>* ${item.name}:
                
                
                  
                
                ${item.description!}
                
              
              
              
                
                  
                    
                    
                  
                
              
            
          
          <#if (endpoint.form.ajaxSubmit)>
          ... WORKING ...
          
            Response:
            
          
          
        
        Hide