«OpenAPI Property»

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 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

OpenAPIProperty

Applicable Elements

Property

Tagged Values

Name

Type

Description

 nullable

boolean

Tagged value defines if the property is nullable or not. Default value is true.

accessType

AccessType

Access type defines if the attribute is READ_ONLY, WRITE_ONLY or READ_WRITE. Default value is READ_WRITE.

 

For further information please refer to: