chore: support admin api v2 #702
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Optional Support for Admin API v2
Summary
This PR adds optional support for the new Admin API v2 (
https://api.aem.live) while maintaining full backward compatibility with the existing Admin API v1 (https://admin.hlx.page). Sites can now opt-in to using API v2 by specifyingapiVersion: 2in their configuration.Changes
Core Implementation
Added new API v2 constant in
src/extension/utils/admin.js:ADMIN_ORIGIN_V2 = 'https://api.aem.live'alongside existingADMIN_ORIGINEnhanced API routing logic:
apiVersion === 2is specified, routes requests to API v2 originAdded default value in
src/extension/app/store/site.js:apiVersion = 1as the default to ensure backward compatibilityBackward Compatibility
✅ No breaking changes: All existing sites continue to use API v1 by default. API v2 is strictly opt-in via configuration.
How to Use API v2
Sites can opt-in to API v2 by adding
apiVersion: 2to their sidekick configuration: