java-undertow-server.interface.mustache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.9.0
{{>licenseInfo}}
package org.openapitools.handler;

import io.undertow.server.*;
import io.undertow.util.*;

import {{modelPackage}}.*;

@SuppressWarnings("TooManyFunctions")
public interface PathHandlerInterface {
{{#apiInfo}}
  {{#apis}}
    {{#operations}}
      {{#operation}}

    /**
{{#summary}}     * {{{summary}}}
     *
{{/summary}}
{{#notes}}     * {{{notes}}}
     *
{{/notes}}
     * Endpoint: {@link Methods#{{{httpMethod}}} {{{httpMethod}}}} "{{{basePathWithoutHost}}}{{{path}}}" (privileged: {{{hasAuthMethods}}})
{{#hasParams}}
     *
     * Request parameters:
     * 
  {{#allParams}}
    {{^isBodyParam}}
     * 
     * "{{{baseName}}}"
{{#description}}     * 
{{{description}}}
{{/description}}
     * 
     * - Parameter type: {{>isContainerDoc}}{{#isModel}}{@link {{{dataType}}}}{{/isModel}}{{^isModel}}{{#isFile}}{{#isBinary}}Binary{{/isBinary}}File{{/isFile}}{{^isFile}}{@link {{dataType}}}{{/isFile}}{{/isModel}}

     * - Appears in: {{#isFormParam}}{@link io.undertow.server.handlers.form.FormDataParser Form}{{/isFormParam}}{{#isQueryParam}}{@link HttpServerExchange#getQueryParameters Query}{{/isQueryParam}}{{#isPathParam}}{@link HttpServerExchange#getPathParameters Path}{{/isPathParam}}{{#isHeaderParam}}{@link Headers Header}{{/isHeaderParam}}{{#isCookieParam}}{@link HttpServerExchange#getRequestCookie Cookie}{{/isCookieParam}}{{#isBodyParam}}{@link HttpServerExchange#getRequestChannel Body}{{/isBodyParam}}

{{#defaultValue}}     * - Default value: {{{defaultValue}}}

{{/defaultValue}}
     * - Required: {{{required}}}
     * 
     * 
    {{/isBodyParam}}
  {{/allParams}}
     * 
{{/hasParams}}
{{#hasResponseHeaders}}
     * Response headers: [{{#responseHeaders}}{{{.}}}{{^-last}}, {{/-last}}{{/responseHeaders}}]
{{/hasResponseHeaders}}
{{#hasConsumes}}
     *
     * Consumes: {{{consumes}}}
{{#hasBodyParam}}{{#bodyParam}}     * Payload: {{>isContainerDoc}}{{#isModel}}{@link {{{dataType}}}}{{/isModel}}{{^isModel}}{{#isFile}}{{#isBinary}}Binary {{/isBinary}}File{{/isFile}}{{^isFile}}{@link {{baseType}}}{{/isFile}}{{/isModel}} (required: {{{required}}}{{/bodyParam}})
{{/hasBodyParam}}
{{/hasConsumes}}
     *
{{#hasProduces}}     * Produces: {{{produces}}}
{{/hasProduces}}
{{#returnBaseType}}     * Returns: {{>isContainerDoc}}{@link {{{returnBaseType}}}}
{{/returnBaseType}}
     *
     * Responses:
     * 
{{#responses}}
     * {{#isDefault}}Default{{/isDefault}}{{^isDefault}}{{{code}}} ({{#is1xx}}informative{{/is1xx}}{{#is2xx}}success{{/is2xx}}{{#is3xx}}redirection{{/is3xx}}{{#is4xx}}client error{{/is4xx}}{{#is5xx}}server error{{/is5xx}}){{/isDefault}}{{#message}}: {{{message}}}{{/message}}
{{/responses}}
     * 
     */
    @javax.annotation.Nonnull
{{#isDeprecated}}    @Deprecated
{{/isDeprecated}}
    HttpHandler {{{operationId}}}();
      {{/operation}}
    {{/operations}}
  {{/apis}}
{{/apiInfo}}
}