When you look at OpenAPI specification you will see there there are some information on data types that can not be expressed in UML. This information are fields are
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
...
readOnly, writeOnly and nullable. The be able to add this information also to the UML model you can apply the stereotype «OpenAPIProperty» on properties in the UML model.
...
Stereotype |
| |||
Applicable Elements | | |||
Tagged Values | ||||
Name | Type | Description | ||
|
| Tagged value defines if the property is nullable or not. Default value |
| Example value that should be added to the OpenAPI specificationis |
|
| Access type defines if the attribute is | ||
For further information please refer to:
...