Skip to content

Admin UI SDK 4.1#549

Open
keharper wants to merge 9 commits into
mainfrom
admin-sdk-403
Open

Admin UI SDK 4.1#549
keharper wants to merge 9 commits into
mainfrom
admin-sdk-403

Conversation

@keharper
Copy link
Copy Markdown
Contributor

@keharper keharper commented May 5, 2026

Purpose of this pull request

Documents Admin UI SDK 4.1.0, which shifts extension registration from the Commerce Admin to App Management. The changes cover new REST endpoints, an updated Configure Extensions modal dialog, upgrade guidance from v3.x to v4.0, and a new App Management configuration reference page.

Key changes:

  • Release notes — Adds v4.1.0 release notes. Notes that v4.0 was not externally released. Covers the App Management migration, the new two-tab Configure Extensions modal, and two new REST endpoints.
  • API reference — Adds the App Management section with POST /V1/adminuisdk/extension and DELETE /V1/adminuisdk/extension/<workspace_name>/<extension_name> endpoint documentation.
  • Configure eligible extensions — Rewrites the page to reflect the new modal dialog (Installed Extensions tab + Manual Extensions Selection tab) and adds an InlineAlert directing developers to App Management.
  • Configuration — Updates the Configure Eligible Extensions button description to match the new behavior.
  • Installation — Adds a v3.x → v4.0 upgrade note explaining that the Configure Extensions modal is deprecated and App Management now handles new app associations.
  • App Management — Admin UI SDK configuration (new page) — Documents the adminUiSdk.registration field in app.commerce.config, including menuItems properties and a full example.

Affected pages

What's New highlights

whatsnew
Updated Admin UI SDK to version 4.1.0. Extensions are now managed through App Management instead of the Commerce Admin. Includes new REST endpoints for managing extensions and a new Admin UI SDK configuration reference for App Builder apps.

@keharper keharper self-assigned this May 5, 2026
@keharper keharper added internal Differentiates work between external and internal contributors new-topic A major update published as an entirely new document labels May 5, 2026
@github-project-automation github-project-automation Bot moved this to 📋 Needs Review in Commerce - Pull Requests May 5, 2026
@keharper keharper changed the title Admin sdk 403 Admin UI SDK 4.1 May 5, 2026
@keharper keharper requested a review from danidelcar May 6, 2026 17:55
@github-project-automation github-project-automation Bot moved this from 📋 Needs Review to 👍 Approved in Commerce - Pull Requests May 7, 2026
Comment thread src/pages/admin-ui-sdk/api.md Outdated
| `extension_title` | string | Yes | The extension title |
| `extension_url` | string | Yes | The extension URL |
| `extension_workspace` | string | Yes | The extension workspace |
| `id` | string | No | Unique ID field |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This id is auto-generated no need to add it to the request

Comment thread src/pages/admin-ui-sdk/api.md Outdated
Comment thread src/pages/admin-ui-sdk/api.md Outdated
Comment thread src/pages/admin-ui-sdk/api.md Outdated
Comment thread src/pages/admin-ui-sdk/api.md

## Menu registration

The `registration` field allows you to declare menu items that will be registered in the Adobe Commerce Admin UI when your application is installed. Menu items can be top-level or nested under a parent menu item.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Menu items can be top-level or nested under a parent menu item.

Not sure I fully understand this statement. Let's check it to make sure it's indeed what can be done.


### Example

The following example shows how to register two menu items, "Apps" and "First App on App Builder", where "First App on App Builder" is nested under "Apps":
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apps in this case is a section, maybe we can explicit more this and now I understand the previous comment I added. I think it's better to have both clearer.

});
```

### Menu item properties
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to display the properties here as well since it's the same as previously and documented in the Admin UI SDK?

Comment thread src/pages/app-management/installation/admin-ui-sdk.md
- App Management
---

# Admin UI SDK configuration
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alone is not enough for now since they still have to do all the Admin UI SDK code manually.
@oshmyheliuk did we release the automatic generation of code? If so, it's worth adding a section on this part in this page.

keharper and others added 2 commits May 7, 2026 09:30
Co-authored-by: Alex Salloum <71198017+asalloum5@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Differentiates work between external and internal contributors new-topic A major update published as an entirely new document

Projects

Status: 👍 Approved

Development

Successfully merging this pull request may close these issues.

4 participants