UML Modeling Guide

Stereotype «OpenAPIProperty»

Stereotype «OpenAPIProperty»

Stereotype «OpenAPIProperty» can be used to define OpenAPI specifc information about a property.


Stereotype «OpenAPIProperty»  
Applicable Elements Property  
Tagged Values    
Name Type Description
nullable Boolean OpenAPI 3.0 does not have an explicit null type as in JSON Schema, but you can use nullable: true to specify that the value may be null.

Note that null is different from an empty string "". Default value is true.

Please be aware that for most cases nullable information can be taken from UML multiplicity information also for OpenAPI.
accessType AccessType Access type can be used to control OpenAPI keywords readOnly and writeOnly.

The following values are possible:
- READ_WRITE: Property will be available in requests and responses
- READ_ONLY: Property is only included in responses but not in requests
- WRITE_ONLY: Property is only included in requests but ot in responses

Default value is READ_WRITE.


Generated by JEAF Generator