«OpenAPI Example»

When working with OpenAPI you will recognize that it has a very simple but cool feature to improve the quality of your documentation: “example values”. OpenAPI allow to define example values for for attributes of types and parameters. To make use of this feature JEAF Generator has another stereotype called «OpenAPIExample» which can be used to provide example values.

Stereotype

OpenAPIExample

Applicable Elements

Parameter , Property

Tagged Values

Name

Type

Description

 value

String

Example value that should be added to the OpenAPI specification.

 

For further information please refer to: