diff --git a/guides/v2.1/extension-dev-guide/attributes.md b/guides/v2.1/extension-dev-guide/attributes.md index 95e77eb8356..ac00d6ac699 100644 --- a/guides/v2.1/extension-dev-guide/attributes.md +++ b/guides/v2.1/extension-dev-guide/attributes.md @@ -113,60 +113,16 @@ You must create a `/etc/extension_attributes.xml` file to define a modul where: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeywordDescriptionExample

for

The fully-qualified type name with the [namespace](https://glossary.magento.com/namespace) that processes the extensions. The value must be a type that implements `ExtensibleDataInterface`. The interface can be in a different module.

Magento\Quote\Api\Data\TotalsInterface

code

The name of the attribute. The attribute name should be in snake case (the first letter in each word should be in lowercase, with each word separated by an underscore).

gift_cards_amount_used

type

The data type. This can be a simple data type, such as string or integer, or complex type, such as an interface.

float
Magento\CatalogInventory\Api\Data\StockItemInterface

ref

Optional. Restricts access to the [extension attribute](https://glossary.magento.com/extension-attribute) to users with the specified permission.

Magento_CatalogInventory::cataloginventory

reference_table

-

The table involved in a join operation. See Searching extension attributes for details.

-
admin_user

reference_field

Column in the reference_table

user_id

join_on_field

The column of the table associated with the interface specified in the for [keyword](https://glossary.magento.com/keyword) that will be used in the join operation.

store_id

field

One or more fields present in the interface specified in the type keyword.

-

You can specify the column="" keyword to define the column in the reference_table to use. The field value specifies the property on the interface which should be set.

firstname
lastname
email

-code
+|Keyword|Description|Example| +|--- |--- |--- | +| for | The fully-qualified type name with the [namespace](https://glossary.magento.com/namespace) that processes the extensions. The value must be a type that implements `ExtensibleDataInterface`. The interface can be in a different module. | `Magento\Quote\Api\Data\TotalsInterface` | +| code | The name of the attribute. The attribute name should be in snake case (the first letter in each word should be in lowercase, with each word separated by an underscore). | `gift_cards_amount_used` | +| type | The data type. This can be a simple data type, such as string or integer, or complex type, such as an interface. | `float`
`Magento\CatalogInventory\Api\Data\StockItemInterface` | +| ref | Optional. Restricts access to the extension attribute to users with the specified permission. | `Magento_CatalogInventory::cataloginventory` | +| reference_table | The table involved in a join operation. See [Searching extension attributes](#search) for details. | `admin_user` | +| reference_field | Column in the `reference_table`. | `user_id` | +| join_on_field | The column of the table associated with the interface specified in the `for` keyword that will be used in the join operation. | `store_id` | +| field | One or more fields present in the interface specified in the `type` keyword.
You can specify the `column=""` keyword to define the column in the reference_table to use. The field value specifies the property on the `interface` which should be set. | `firstname`
`lastname`
`email`

`code` | ### Searching extension attributes {#search}