Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/pages/admin-ui-sdk/app-review-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ Category | Description | Required?
--- | --- | ---
`@adobe/uix-core` and `@adobe/uix-guest` version | The [dependencies version](./app-registration.md#add-an-extensionregistration-component) from `@adobe/uix-sdk` must be set to `1.0.3` to be compatible with Admin UI SDK.| Required
`app.config.yaml`| Apps that include the Admin UI SDK must be configured as an [extension](https://developer.adobe.com/app-builder/docs/guides/app_builder_guides/extensions/extensions), and not as a single page application. Therefore, your `app.config.yaml` file must contain an `extensions` block and no `application` block. If you used the integration or checkout starter kit as the foundation of your app, you must convert it to an extension. | Required
Application routing | [App routing](./app-registration.md#update-the-appjs-routing) must redirect to the `ExtensionRegistration` component, which redirects to the main page.| Required
Application routing | [App routing](./app-registration.md#update-the-appjs-routing) must redirect to the `ExtensionRegistration` component. If the menu extension point is being used, the `ExtensionRegistration` component must also redirect to the main page.| Required
Code layout | The code is organized within a `commerce-backend-ui-1` folder that includes `actions` and `web-src` subdirectories, as shown in [Code layout best practices](./app-registration.md#code-layout-best-practices).| Preferred
`ext.config.yaml` | An [`ext.config.yaml` file](./app-registration.md#add-or-update-the-extconfigyaml) is created with at least one runtime action for the Admin UI SDK registration. It must be secured with `require-adobe-auth` set to `true`. | Required
Extension Registration | The extension registration is correctly coded with a unique [extension ID](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/app-registration/#add-an-extensionregistration-component).| Required
Extension Registration | If the menu extension point is used, the extension ID should only contain the allowed characters mentioned in the [menu parameters documentation](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/extension-points/menu/#parameters).| Required
Extension Registration | Use the same extension ID in the `extension-manifest` file, the `registration` action, the `attach` function, and the `register` function. Using the same extension ID is only mandatory when attaching and registering.| Preferred
Main page requiring shared data | If the main page requires data from the [shared context](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/extension-points/#shared-contexts) (such as an IMS token or org ID), ensure the extension ID used to `attach` is the same as the one used to `register` in the `ExtensionRegistration` component. | Required
Mandatory config files | The application has `extension-manifest.json` and `install.yaml` [files](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/app-registration/#add-or-update-the-installyml-file). The `install.yaml` file references the `commerce/backend-ui/1` extension point.|Required
Expand Down