Reference Properties
Gotransverse API 2.0 supports the following reference properties:
| Reference Property | Type | Description |
|---|---|---|
|
required |
boolean |
Determines whether the parameter is mandatory. If the parameter location is path, this property is required, and its value must be TRUE. Default value is FALSE. |
|
deprecated |
boolean |
Specifies that a parameter is deprecated and should be transitioned out of usage. Default value is FALSE. |
|
readOnly |
boolean |
Relevant only for Schema properties definitions. Declares the property as read-only. This means that it may be sent as part of a response but cannot be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required property will take effect on the response only. A property cannot be marked as both readOnly and writeOnly being true. Default value is FALSE. |
|
nullable |
boolean |
A TRUE value adds null to the allowed type specified by the type keyword only if type is explicitly defined within the same Schema Object. A FALSE value leaves the specified or default type unmodified. Default value is FALSE. |
|
expandable |
boolean |
Determines whether this field can be expanded, which means it can have additional values if set. Default value is FALSE. |