feat(content-preview): add metadataApiHost prop for regional metadata

[mborkowski-box]

Summary by CodeRabbit

Release Notes

• New Features

  • Added optional metadataApiHost configuration to ContentPreview and ContentSidebar components for routing metadata instance requests to regional endpoints.

• Tests

  • Added comprehensive test coverage for regional metadata request routing behavior.

• Documentation

  • Updated component documentation to document the new metadataApiHost prop and its regional routing behavior.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5f2a9536-82dd-449c-b8d2-6cb0a75a7239

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

This PR adds optional metadataApiHost configuration to enable routing metadata instance endpoints (file and folder metadata) to a regional API host. The feature flows from type definitions through API layer routing logic to UI component props, with comprehensive tests and documentation at each layer.

Changes

Regional Metadata API Host Support

Layer / File(s)	Summary
API Configuration & Type Definitions src/common/types/api.js, src/api/Base.js	APIOptions type gains optional metadataApiHost field; Base class adds metadataApiHost instance field, accepts it in the constructor, stores it in this.options, and introduces buildApiUrl(host) helper to construct normalized API URLs with /2.0 suffix and trailing-slash handling.
Metadata Instance Routing Logic src/api/Metadata.js, src/api/__tests__/Metadata.test.js	Metadata class adds getMetadataInstanceBaseUrl() helper to choose the host for instance endpoints based on metadataApiHost when set and distinct from apiHost, otherwise falling back to getBaseApiUrl(). Methods getMetadataUrl() and getMetadataUrlForFolder() now route through this helper. Tests verify regional routing, fallback behavior, trailing-slash normalization, and that other metadata endpoints (templates, suggestions, options, taxonomies) remain on apiHost.
ContentPreview Component Integration src/elements/content-preview/ContentPreview.js, src/elements/content-preview/__tests__/ContentPreview.test.js, src/elements/content-preview/stories/ContentPreview.mdx	ContentPreview accepts optional metadataApiHost prop, wires it into the API client options, and forwards it to LoadableSidebar. Tests verify forwarding and back-compat when omitted. Documentation describes the prop's role for regional metadata instance endpoints.
ContentSidebar Component Integration src/elements/content-sidebar/ContentSidebar.js, src/elements/content-sidebar/__tests__/ContentSidebar.test.js, src/elements/content-sidebar/stories/ContentSidebar.mdx	ContentSidebar accepts optional metadataApiHost prop, passes it into API client initialization. Tests verify prop acceptance, forwarding, and backward compatibility. Documentation describes the prop's scope for metadata instance endpoints.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

ready-to-merge

Suggested reviewers

• dlasecki-box
• reneshen0328
• tjuanitas

Poem

🐰 A regional hop, across the API gate,
Where metadata instances celebrate their fate,
From component prop to routing layer deep,
Backward-compatible promises we keep,
One metadataApiHost, seamlessly in place!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The PR description contains only a template/boilerplate note about merge procedures without substantive information about the actual changes or implementation details.	Add a description explaining what metadataApiHost does, why it was added, which components are affected, and any migration notes or testing guidance for reviewers.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding a metadataApiHost prop for regional metadata support across multiple components.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[mborkowski-box]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.