feat(metadata-editor): Metadata API adjustments

[DanilaRubleuski]

Description

Following the recent API specification updates for Options and Nodes endpoints, new API testing on dev environment has been successful. The current ML taxonomies implementation is working fine with the updated APIs, indicating that minimal changes are needed at this time.

Changes Made

Core Attribute Support
Added support for new API response fields in metadataTaxonomyFetcher:
parentId - Parent node identifier for hierarchical relationships
nodePath - Array of ancestor node IDs representing the path from root
deprecated - Boolean flag indicating if the option is deprecated
totalResultCount - Total number of results available
limit - Current result limit

Backward Compatibility

• Support is still in place for both legacy field names (display_name) and new names (displayName)

• Handling of missing new fields - they're passed through as undefined if not present

• No breaking changes to existing functionality

Testing Coverage

• Updated unit tests to verify new field mapping

• Added test cases for backward compatibility scenarios

• Verified handling of missing fields to ensure robustness

Screenshots and recordings

Screen.Recording.2025-07-16.at.20.37.06.mov

Summary by CodeRabbit

• New Features

  • Enhanced metadata options to include additional details such as parent ID, node path, and deprecation status.
  • The response now provides pagination information, including total result count and limit when available.

• Tests

  • Expanded test coverage to validate handling of new metadata fields and ensure backward compatibility with older data.

[coderabbitai]

Walkthrough

The metadataTaxonomyFetcher function was updated to include additional metadata fields (parentId, nodePath, deprecated) in its output, as well as pagination properties (totalResultCount, limit) when available. Corresponding tests were expanded to verify the presence and handling of these new fields, including backward compatibility scenarios.

Changes

File(s)	Change Summary
src/elements/content-sidebar/fetchers/metadataTaxonomyFetcher.ts	Enhanced fetcher to return parentId, nodePath, deprecated, and optionally totalResultCount, limit in its response.
src/elements/content-sidebar/tests/metadataTaxonomyFetcher.test.ts	Expanded and added tests to cover new fields, pagination properties, backward compatibility, and updated expected results.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant metadataTaxonomyFetcher
    participant API

    Caller->>metadataTaxonomyFetcher: Call fetcher with params
    metadataTaxonomyFetcher->>API: Fetch metadata options
    API-->>metadataTaxonomyFetcher: Return metadataOptions (with/without new fields)
    metadataTaxonomyFetcher-->>Caller: Return options with parentId, nodePath, deprecated, limit, totalResultCount

Loading

Suggested labels

ready-to-merge

Poem

In the warren of code, new fields appear,
parentId, nodePath, and deprecated—all here!
The fetcher now brings more carrots to share,
With tests that ensure backward flair.
Pagination hops in, the results multiply—
A bunny’s delight, as the code bounces high!
🥕✨

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• CIRCLECI integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0716469 and 0c28a7b.

📒 Files selected for processing (1)

• src/elements/content-sidebar/__tests__/metadataTaxonomyFetcher.test.ts (5 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/elements/content-sidebar/tests/metadataTaxonomyFetcher.test.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: lint_test_build
• GitHub Check: Summary

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[bkepka-box]

Should we also add a test to check that limit and totalResultCount is not returned when metadataOptions does not have them?