File tree Expand file tree Collapse file tree
api/src/main/java/org/eclipse/microprofile/openapi/annotations/headers Expand file tree Collapse file tree Original file line number Diff line number Diff line change 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 *
You can’t perform that action at this time.
0 commit comments