Summary of property attributes
The following attributes are direct children of the property
declaration:
Attribute | Description | Example |
---|---|---|
readOnly |
Boolean identifying if the property as read-only. (The default is false.) | "readOnly": true |
x-gw-nullable |
Boolean identifying if the property can be explicitly set to null. (The default is true.) Used to set a property as required by the database. For more information, see Properties required by the database. | "x-gw-nullable": false |
x-gw-sinceExtensionsVersion |
String identifying the first version of the API to include the extension property | "x-gw-sinceExtensionsVersion": "1.1.0" |
The following attributes are declared in the x-gw-extension
object:
Attribute | Description | Example |
---|---|---|
createOnly |
Boolean identifying if the property can be specified only when the object is created. (The default is false.) | "createOnly": true |
filterable |
Boolean identifying if the filter query parameter
can be used on this property. In other words, collections can be
filtered using this property. (The default is false.) |
"filterable": true |
requiredForCreate |
Boolean identifying if the property must be specified when the object is created. (The default is false.) Used to set a property as required by the database. For more information, see Properties required by the database. | "requiredForCreate": true |
sortable |
Boolean identifying if the sort query parameter can
be used on this property. In other words, collections can be sorted
using this property. (The default is false.) |
"sortable": true
|