Preparing search index...
The search index is not available
@samchon/openapi
@samchon/openapi
OpenApiV3
IOperation
Interface IOperation
interface
IOperation
{
deprecated
?:
boolean
;
description
?:
string
;
operationId
?:
string
;
parameters
?:
(
|
OpenApiV3
.
IOperation
.
IParameter
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/headers/
${
string
}
`
>
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/parameters/
${
string
}
`
>
)
[]
;
requestBody
?:
|
OpenApiV3
.
IOperation
.
IRequestBody
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/requestBodies/
${
string
}
`
>
;
responses
?:
Record
<
string
,
|
OpenApiV3
.
IOperation
.
IResponse
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/responses/
${
string
}
`
>
,
>
;
security
?:
Record
<
string
,
string
[]
>
[]
;
servers
?:
OpenApiV3
.
IServer
[]
;
summary
?:
string
;
tags
?:
string
[]
;
}
Index
Properties
deprecated?
description?
operation
Id?
parameters?
request
Body?
responses?
security?
servers?
summary?
tags?
Properties
Optional
deprecated
deprecated
?:
boolean
Optional
description
description
?:
string
Optional
operation
Id
operationId
?:
string
Optional
parameters
parameters
?:
(
|
OpenApiV3
.
IOperation
.
IParameter
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/headers/
${
string
}
`
>
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/parameters/
${
string
}
`
>
)
[]
Optional
request
Body
requestBody
?:
|
OpenApiV3
.
IOperation
.
IRequestBody
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/requestBodies/
${
string
}
`
>
Optional
responses
responses
?:
Record
<
string
,
|
OpenApiV3
.
IOperation
.
IResponse
|
OpenApiV3
.
IJsonSchema
.
IReference
<
`
#/components/responses/
${
string
}
`
>
,
>
Optional
security
security
?:
Record
<
string
,
string
[]
>
[]
Optional
servers
servers
?:
OpenApiV3
.
IServer
[]
Optional
summary
summary
?:
string
Optional
tags
tags
?:
string
[]
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
deprecated
description
operation
Id
parameters
request
Body
responses
security
servers
summary
tags
@samchon/openapi
Loading...