php-symfony.api.mustache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-codegen Show documentation

There is a newer version: 3.0.0-rc1

partial_header}}
/**
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen
 * Do not edit the class manually.
 */

namespace {{apiPackage}};

use Symfony\Component\HttpFoundation\File\UploadedFile;
{{#operations}}{{#imports}}use {{import}};
{{/imports}}

/**
 * {{classname}} Interface Doc Comment
 *
 * @category Interface
 * @package  {{apiPackage}}
 * @author   Swagger Codegen team
 * @link     https://github.com/swagger-api/swagger-codegen
 */
interface {{classname}}
{
    {{#authMethods}}

    /**
     * Sets authentication method {{name}}
     *
     * @param string $value Value of the {{name}} authentication method.
     *
     * @return void
     */
    public function set{{name}}($value);
    {{/authMethods}}
    {{#operation}}

    /**
    {{#isDeprecated}}
     * @deprecated
    {{/isDeprecated}}
     * Operation {{{operationId}}}
    {{#summary}}
     *
     * {{{summary}}}
    {{/summary}}
     *
    {{#description}}
     * {{.}}
     *
    {{/description}}
    {{#allParams}}
     * @param  {{vendorExtensions.x-commentType}} ${{paramName}}  {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
    {{/allParams}}
     * @param  integer $responseCode     The HTTP response code to return
     * @param  array   $responseHeaders  Additional HTTP headers to return with the response ()
     *
     * @return {{{vendorExtensions.x-commentType}}}
     *
     */
    public function {{operationId}}({{#allParams}}{{#vendorExtensions.x-parameterType}}{{vendorExtensions.x-parameterType}} {{/vendorExtensions.x-parameterType}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}, {{/allParams}}&$responseCode, array &$responseHeaders);
{{/operation}}
}
{{/operations}}