Package de.kosmos_lab.web.annotations
Annotation Type Operation
-
@Retention(RUNTIME) @Target(METHOD) public @interface Operation
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description booleandeprecatedStringdescriptionExtension[]extensionsExternalDocumentationexternalDocsbooleanhiddenbooleanignoreJsonViewStringmethodStringoperationIdParameter[]parametersRequestBodyrequestBodyApiResponse[]responsesSecurityRequirement[]securityServer[]serversStringsummaryString[]tags
-
-
-
Element Detail
-
method
String method
- Default:
- ""
-
-
-
tags
String[] tags
- Default:
- {}
-
-
-
summary
String summary
- Default:
- ""
-
-
-
description
String description
- Default:
- ""
-
-
-
requestBody
RequestBody requestBody
- Default:
- @de.kosmos_lab.web.annotations.parameters.RequestBody
-
-
-
externalDocs
ExternalDocumentation externalDocs
- Default:
- @de.kosmos_lab.web.annotations.ExternalDocumentation
-
-
-
operationId
String operationId
- Default:
- ""
-
-
-
parameters
Parameter[] parameters
- Default:
- {}
-
-
-
responses
ApiResponse[] responses
- Default:
- {}
-
-
-
security
SecurityRequirement[] security
- Default:
- {}
-
-
-
servers
Server[] servers
- Default:
- {}
-
-
-
extensions
Extension[] extensions
- Default:
- {}
-
-
-
hidden
boolean hidden
- Default:
- false
-
-