templates.kotlin-micronaut.server.doc.controller_doc.mustache Maven / Gradle / Ivy

Go to download
# {{classname}}{{#description}}
{{description}}{{/description}}

All URIs are relative to `"{{contextPath}}"`

The controller class is defined in **[{{classname}}.kt](../../{{{apiFolder}}}/{{classname}}.kt)**

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
{{#operations}}
    {{#operation}}
| [**{{operationId}}**](#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} |
    {{/operation}}
{{/operations}}

{{#operations}}
    {{#operation}}

# **{{operationId}}**
```kotlin
fun {{classname}}.{{nickname}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}}): {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Mono{{/returnType}}
```

{{summary}}{{#notes}}

{{notes}}{{/notes}}

{{#allParams}}
    {{#-last}}
### Parameters
| Name | Type | Description  | Notes |
------------- | ------------- | ------------- | -------------
{{#allParams}}
| **{{vendorExtensions.realName}}** | {{^isPrimitiveType}}[**{{dataType}}**](../../{{modelDocPath}}/{{baseType}}.md){{/isPrimitiveType}}{{#isPrimitiveType}}`{{dataType}}`{{/isPrimitiveType}} | {{description}} |{{^required}} [optional parameter]{{/required}}{{#defaultValue}} [default to `{{defaultValue}}`]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}`{{{.}}}`{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}} |
{{/allParams}}
    {{/-last}}
{{/allParams}}

{{#returnType}}
### Return type
    {{#returnTypeIsPrimitive}}
`{{returnType}}`
    {{/returnTypeIsPrimitive}}
    {{^returnTypeIsPrimitive}}
[**{{returnType}}**](../../{{modelDocPath}}/{{returnBaseType}}.md)
    {{/returnTypeIsPrimitive}}
{{/returnType}}

{{#authMethods}}
    {{#-last}}
### Authorization
        {{#authMethods}}
* **{{name}}**{{#scopes}}{{#-last}}, scopes: {{#scopes}}`{{{scope}}}`{{^-last}}, {{/-last}}{{/scopes}}{{/-last}}{{/scopes}}
        {{/authMethods}}
    {{/-last}}
{{/authMethods}}

### HTTP request headers
 - **Accepts Content-Type**: {{#consumes}}`{{{mediaType}}}`{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
 - **Produces Content-Type**: {{#produces}}`{{{mediaType}}}`{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}

    {{/operation}}
{{/operations}}