Interface OperationObjectWithMetadata

interface OperationObjectWithMetadata {
    callbacks?: { [callback: string]: ReferenceObject | CallbackObject };
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    method: string;
    operationId?: string;
    parameters?: (ReferenceObject | ParameterObject)[];
    path: string;
    requestBody?: ReferenceObject | RequestBodyObject;
    responses: ResponsesObject;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: string[];
}

Hierarchy

  • OperationObject
    • OperationObjectWithMetadata

Properties

callbacks?: { [callback: string]: ReferenceObject | CallbackObject }
deprecated?: boolean
description?: string
externalDocs?: ExternalDocumentationObject
method: string
operationId?: string
parameters?: (ReferenceObject | ParameterObject)[]
path: string
requestBody?: ReferenceObject | RequestBodyObject
responses: ResponsesObject
security?: SecurityRequirementObject[]
servers?: ServerObject[]
summary?: string
tags?: string[]