/**
 * PyroFetes
 *
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { RequestExample } from './request-example';
import { ResponseHeader } from './response-header';


/**
 * a class used for providing a textual description about an endpoint for swagger
 */
export interface EndpointSummary { 
    /**
     * the short summary of the endpoint
     */
    summary?: string;
    /**
     * the long description of the endpoint
     */
    description?: string;
    /**
     * specify multiple request examples by adding to this collection.
     */
    requestExamples?: Array<RequestExample>;
    /**
     * an example request object to be used in swagger/ openapi. multiple examples can be specified by setting this property multiple times or by adding to the RequestExamples collection.
     */
    exampleRequest?: any | null;
    /**
     * the descriptions for endpoint parameters. you can add descriptions for route/query params and request dto properties. what you specify here will take precedence over xml comments of dto classes (if they are also specified).
     */
    params?: { [key: string]: string; };
    /**
     * the descriptions of the different responses/ status codes an endpoint can return
     */
    responses?: { [key: string]: string; };
    /**
     * the response examples for each status code
     */
    responseExamples?: { [key: string]: any; };
    responseHeaders?: Array<ResponseHeader>;
}