Skip to main content

Relation

Relation describes relations between resources. Used in PropertyMeta.relation

Properties​

descriptionPropertyName​

descriptionPropertyName: string

Name of property of related resource that represents description for this resource.

expandForDescription​

expandForDescription: boolean

Controls, if some UI components such as ResourceList during the query to backend to get resources will request to expand related object and will get from backend its related resource through Relation.descriptionPropertyName.

For example, for Person resource, if its related resource PhoneBrand has decorator @descriptionProperty(phoneBrandProps.company) then the PhoneBrand resource will be displayed as PhoneBrand.company.