{{nickname}}
{{summary}}
{{notes}}
{{path}}
Usage and SDK Samples
curl -X {{vendorExtensions.x-codegen-httpMethodUpperCase}}{{#authMethods}}{{#isApiKey}}{{#isKeyInHeader}} -H "{{keyParamName}}: [[apiKey]]"{{/isKeyInHeader}}{{/isApiKey}}{{#isBasic}}{{#hasProduces}} -H "Accept: {{#produces}}{{{mediaType}}}{{#hasMore}},{{/hasMore}}{{/produces}}"{{/hasProduces}}{{#hasConsumes}} -H "Content-Type: {{#consumes}}{{{mediaType}}}{{#hasMore}},{{/hasMore}}{{/consumes}}"{{/hasConsumes}} -H "Authorization: Basic [[basicHash]]"{{/isBasic}}{{/authMethods}} "{{basePath}}{{path}}{{#hasQueryParams}}?{{#queryParams}}{{^-first}}&{{/-first}}{{baseName}}={{vendorExtensions.x-eg}}{{/queryParams}}{{/hasQueryParams}}"
{{>sample_java}}
{{>sample_android}}
{{>sample_objc}}
{{>sample_js}}
{{>sample_csharp}}
{{>sample_php}}
{{>sample_perl}}
{{>sample_python}}
Parameters
{{#hasPathParams}}Path parameters
Name | Description |
---|
Header parameters
Name | Description |
---|
Body parameters
Name | Description |
---|
Form parameters
Name | Description |
---|
Query parameters
Name | Description |
---|
Responses
{{#responses}}Status: {{code}} - {{message}}
{{#schema}}
{{#examples}}
{{/examples}}
{{/schema}}
{{#hasHeaders}}
{{/hasHeaders}}
{{/responses}}
{{example}}
Name | Type | Format | Description |
---|---|---|---|
{{#name}}{{name}}{{/name}} | {{#datatype}}{{dataType}}{{/datatype}} | {{#dataFormat}}{{dataFormat}}{{/dataFormat}} | {{#description}}{{description}}{{/description}} |