${order}. ${desc}
<%if(doc.deprecated){%>${order}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${order}.${doc.order}. ${htmlEscape(doc.desc)}<%}%>
URL: ${doc.url}
Type: ${doc.type}
Author: ${doc.author}
Content-Type: ${doc.contentType}
Description: ${lineBreaksToBr(doc.detail)}
Request-headers:
| Header | Value | Type | Required | Description | |
|---|---|---|---|---|---|
${header.name} |
${header.type} |
${header.required} |
${htmlEscape(header.desc)} |
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
${param.field} |
${param.type} |
${param.required} |
${htmlEscape(param.desc)} |
Query-parameters:
| Parameter | Value | Type | Required | Description | ||
|---|---|---|---|---|---|---|
${param.field} |
<%if(param.type=="file"&&!param.hasItems){%><%}else if(param.type=="file"&¶m.hasItems){%><%}else{%><%}%> |
${param.type} |
${param.required} |
<%if(param.version!='-'){%>
${htmlEscape(param.desc)}@since ${param.version} |
<%}else{%>
${htmlEscape(param.desc)} |
<%}%>
Body-parameters:
| Parameter | Value | Type | Required | Description | ||
|---|---|---|---|---|---|---|
${param.field} |
<%if(param.type=="file"&&!param.hasItems){%><%}else if(param.type=="file"&¶m.hasItems){%><%}else{%><%}%> |
${param.type} |
${param.required} |
<%if(param.version!='-'){%>
${htmlEscape(param.desc)}@since ${param.version} |
<%}else{%>
${htmlEscape(param.desc)} |
<%}%>
Body-parameters:
| Parameter | Type | Required | Description | |
|---|---|---|---|---|
${param.field} |
${param.type} |
${param.required} |
<%if(param.version!='-'){%>
${htmlEscape(param.desc)}@since ${param.version} |
<%}else{%>
${htmlEscape(param.desc)} |
<%}%>
Request-body:
${doc.requestExample.jsonBody}
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
${param.field} |
${param.type} |
${htmlEscape(param.desc)} |
${param.version} |
Response-example:
${doc.responseUsage}
Curl-example:
${doc.requestUsage}