Package de.kosmos_lab.web.doc.openapi
Annotation Type Message
-
@Retention(RUNTIME) @Target({TYPE,METHOD}) @Repeatable(Messages.class) public @interface Message
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description StringcontentTypeStringdescriptionExampleObject[]examplesStringexternalDocsHeader[]headersStringnameObjectSchemapayloadString[]payloadRefsSchemapayloadSchemaStringsummaryTag[]tagsStringtitleObjectSchemaxResponseString[]xResponseRefsSchemaxResponseSchema
-
-
-
Element Detail
-
headers
Header[] headers
- Default:
- {}
-
-
-
contentType
String contentType
- Default:
- "application/json"
-
-
-
name
String name
- Default:
- ""
-
-
-
title
String title
- Default:
- ""
-
-
-
summary
String summary
- Default:
- ""
-
-
-
description
String description
- Default:
- ""
-
-
-
tags
Tag[] tags
- Default:
- {}
-
-
-
externalDocs
String externalDocs
- Default:
- ""
-
-
-
examples
ExampleObject[] examples
- Default:
- {}
-
-
-
payloadRefs
String[] payloadRefs
- Default:
- {}
-
-
-
xResponseRefs
String[] xResponseRefs
- Default:
- {}
-
-
-
payload
ObjectSchema payload
- Default:
- @de.kosmos_lab.web.annotations.media.ObjectSchema
-
-
-
xResponse
ObjectSchema xResponse
- Default:
- @de.kosmos_lab.web.annotations.media.ObjectSchema
-
-
-
payloadSchema
Schema payloadSchema
- Default:
- @de.kosmos_lab.web.annotations.media.Schema
-
-
-
xResponseSchema
Schema xResponseSchema
- Default:
- @de.kosmos_lab.web.annotations.media.Schema
-
-