Skip to content

Commit

Permalink
Schema model: revert changes to example
Browse files Browse the repository at this point in the history
Example is still a valid keyword in OpenAPI 3.1, though it is deprecated
in favor of examples.
  • Loading branch information
Azquelt committed Apr 4, 2024
1 parent 34413ef commit 0002c97
Showing 1 changed file with 5 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -983,7 +983,7 @@ default Schema writeOnly(Boolean writeOnly) {
}

/**
* Returns the first value from the examples property from this Schema instance.
* Returns the example property from this Schema instance.
*
* @return an object which is an example of an instance of this Schema
* @deprecated use {@link #getExamples()}
Expand All @@ -992,7 +992,8 @@ default Schema writeOnly(Boolean writeOnly) {
Object getExample();

/**
* Sets the examples property of this Schema instance to a single example.
* Sets the example property of this Schema instance. To represent examples that cannot be naturally represented in
* JSON or YAML, a string value can be used to contain the example with escaping where necessary.
*
* @param example
* an object which is an instance of this Schema
Expand All @@ -1002,7 +1003,8 @@ default Schema writeOnly(Boolean writeOnly) {
void setExample(Object example);

/**
* Sets the examples property of this Schema instance to a single example.
* Sets the example property of this Schema instance. To represent examples that cannot be naturally represented in
* JSON or YAML, a string value can be used to contain the example with escaping where necessary.
*
* @param example
* an object which is an instance of this Schema
Expand Down

0 comments on commit 0002c97

Please sign in to comment.