mirror of
https://github.com/longbridge/developers.git
synced 2026-09-19 03:34:09 +08:00
60 lines
1.3 KiB
Modula-2
60 lines
1.3 KiB
Modula-2
{{= data.tags.section }}
|
|
#### Parameters
|
|
|
|
> Content-Type: application/json; charset=utf-8
|
|
|
|
| Name | Type | Required | Description |
|
|
|---|---|---|---|
|
|
{{~ data.parameters :p}}| {{=p.name}} | {{=p.safeType}} | {{= p.required === true ? 'YES' : 'NO'}} | {{=p.shortDesc || 'none'}} |
|
|
{{~}}
|
|
|
|
{{? data.longDescs }}
|
|
#### Detailed descriptions
|
|
{{~ data.parameters :p}}{{? p.shortDesc !== p.description}}
|
|
**{{=p.name}}**: {{=p.description}}{{?}}
|
|
{{~}}
|
|
{{?}}
|
|
|
|
|
|
{{? data.operation.request_body }}
|
|
#### Request Example
|
|
|
|
|
|
{{? data.operation.request_body.type == "json"}}
|
|
```json
|
|
{{= JSON.stringify(data.operation.request_body.value || {}, null, 2) }}
|
|
```
|
|
{{??}}
|
|
```{{=data.operation.request_body.type}}
|
|
{{= (data.operation.request_body.value || "").trim() }}
|
|
```
|
|
{{?}}
|
|
{{?}}
|
|
|
|
|
|
{{~ data.parameters :p}}
|
|
|
|
{{? p.schema && p.schema.enum }}
|
|
{{~ p.schema.enum :e}}
|
|
{{ var entry = {}; entry.name = p.name; entry.value = e; data.enums.push(entry); }}
|
|
{{~}}
|
|
{{?}}
|
|
|
|
{{? p.schema && p.schema.items && p.schema.items.enum }}
|
|
{{~ p.schema.items.enum :e}}
|
|
{{ var entry = {}; entry.name = p.name; entry.value = e; data.enums.push(entry); }}
|
|
{{~}}
|
|
{{?}}
|
|
|
|
{{~}}
|
|
|
|
{{? data.enums && data.enums.length }}
|
|
#### Enumerated Values
|
|
|
|
| Parameter | Value |
|
|
|---|---|
|
|
{{~ data.enums :e}}| {{=e.name}} | {{=data.utils.toPrimitive(e.value)}} |
|
|
{{~}}
|
|
{{?}}
|
|
{{= data.tags.endSection }}
|