Skip to content

Type Alias: OperationObject<T>

ts
type OperationObject<T> = {
  callbacks?: {
    [callback: string]: ReferenceObject | CallbackObject;
  };
  deprecated?: boolean;
  description?: string;
  externalDocs?: ExternalDocumentationObject;
  operationId?: string;
  parameters?: (ReferenceObject | ParameterObject)[];
  requestBody?: ReferenceObject | RequestBodyObject;
  responses: ResponsesObject;
  security?: SecurityRequirementObject[];
  servers?: ServerObject[];
  summary?: string;
  tags?: string[];
} & T;

Type Declaration

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

Type Parameters

Type ParameterDefault type
T extends { }{ }