• Home
• guru.nidi.raml
• raml-doc-client
• 0.8.2
• source code
• namedParams.stg

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

guru.nidi.raml.doc.st-templates.namedParams.stg Maven / Gradle / Ivy

header(baseUri) ::= <<
    
            $if(baseUri)$  $endif$
            
>>

footer() ::= <<
        

        

        

            
Name
Value
Description
            
Example
            
Type
            
Constraints
            
Default
        
        
        

    
>>

namedParams(title,params,baseUri,type) ::= <<
    $if(params)$
        
$title$
        $header(baseUri)$
            $params.entrySet:paramEntry(baseUri,type)$
        $footer()$
    $endif$
>>

namedParamsElem(title,params,baseUri,type,addable) ::= <<
    $if(params || (baseUri && addable))$
        $title(title,baseUri,addable)$
        $params.entrySet:paramEntry(baseUri,type)$
    $endif$
>>

namedParamsBody(body,baseUri) ::= <<
    $if(body)$
        
            
                Body
            
            
                $if(body.hasSingleValue)$
                    $first(body.keys)$
                $else$
                    
                        $body.keys:{key | $key$}$
                    
                $endif$
            
            
        
        $body.entrySet:{entry | $mime(body.keys,entry.key,entry.value,baseUri)$}$
        
    $endif$
>>

mime(keys,key,body,baseUri) ::= <<
    
    $namedParamsElem("Form parameters",body.formParameters,baseUri,"f",false)$
    
        
        $if(baseUri)$
            
                
            
        $else$
            
        $endif$
        
        
            $schemaExample(body)$
        
    
>>

schemaExample(value) ::= <<
    $if(value.schema || value.example)$
        $if(value.schema)$
            model
        $endif$
        |
        $if(value.example)$
            example
        $endif$
        

            $if(docson)$
                
            $else$
                
$value.schema;format="schema,js"$
            $endif$
        
        

            
$value.example;format="js"$
            
$value.example;format="js"$
        
    $endif$
>>

title(title,baseUri,addable) ::= <<
    
        
            $title$
            $if(baseUri && addable)$  $endif$
        
    
>>

paramEntry(entry,baseUri,type) ::= <<
    $entry.value:{val | $param(entry.key,val,baseUri,type)$ }$
>>

param(key,param,baseUri,type) ::= <<
    
        $def(param.displayName,key)$$if (param.required)$*$endif$
        $if(baseUri)$  $endif$
        $param.description;format="markdown"$
        $param.example$
        $param;format="type"$
        
            $if (param.enumeration)$ 
$param;format="enum"$
 $endif$
            $if (param.pattern)$ 
$param.pattern$
 $endif$
            $if (param.minLength || param.maxLength)$ 
$param;format="strLimit"$
 $endif$
            $if (param.minimum || param.maximum)$ 
$param;format="intLimit"$
 $endif$
        
        $param.defaultValue$
    
>>

def(value,def) ::= <%
$if(value)$
    $value$
$else$
    $def$
$endif$
%>