Skip to content

Commit 66c09ba

Browse files
committed
Align Header#example JavaDoc with ExampleObject#value
Signed-off-by: Michael Edgar <michael@xlate.io>
1 parent 3b970a7 commit 66c09ba

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

  • api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers

api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers/Header.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,10 @@
115115
* Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if
116116
* present. The {@code example} field is mutually exclusive of the {@link #examples() examples} field. Furthermore,
117117
* if referencing a {@link #schema() schema} that contains an example, the {@code example} value SHALL override the
118-
* example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON
119-
* or YAML, a string value can contain the example with escaping where necessary.
118+
* example provided by the schema.
119+
* <p>
120+
* If the media type associated with the example allows parsing into an object, it may be converted from a string.
121+
* </p>
120122
*
121123
* @return an example of the header
122124
*

0 commit comments

Comments
 (0)