Skip to content

Conversation

@aalves08
Copy link
Member

@aalves08 aalves08 commented Oct 9, 2025

Summary

Fixes #15597
Fixes #15850

Important notice: needs a rebase from #15532 once that's merged

Occurred changes and/or fixed issues

  • Update Shell API's methods usage signature to a pattern more "up-to-date" and easy to be consumed
  • Integrate the Notification Center with the Shell API
  • Add information for when the Shell API is available to be consumed
  • Update typedoc integration to auto-generate new documentation (remove commented code so it's enabled by default)
  • Remove growls from Shell API (deprecated)
  • Add new System API to Shell API
  • Fixes minor issues with focus trap on Shell API methods
  • add unit tests for Shell API implementation

Technical notes summary

Areas or cases that should be tested

  • Check if documentation looks and builds fine
  • Check if all Shell API methods are working fine and display intellisense

Areas which could experience regressions

Screenshot/Video

Checklist

  • The PR is linked to an issue and the linked issue has a Milestone, or no issue is needed
  • The PR has a Milestone
  • The PR template has been filled out
  • The PR has been self reviewed
  • The PR has a reviewer assigned
  • The PR has automated tests or clear instructions for manual tests and the linked issue has appropriate QA labels, or tests are not needed
  • The PR has reviewed with UX and tested in light and dark mode, or there are no UX changes
  • The PR has been reviewed in terms of Accessibility

@aalves08 aalves08 added this to the v2.13.0 milestone Oct 13, 2025
@aalves08 aalves08 requested a review from nwmac October 13, 2025 13:55
@aalves08 aalves08 changed the title 15597 update shell api method signatures Update Shell API's method signatures and enable typedoc integration Oct 13, 2025
@aalves08 aalves08 marked this pull request as ready for review October 13, 2025 13:57
@nwmac nwmac modified the milestones: v2.13.0, v2.14.0 Oct 28, 2025
@aalves08 aalves08 force-pushed the 15597-update-shell-api-method-signatures branch 2 times, most recently from 1e1160c to 3d2dd0a Compare November 10, 2025 17:17
@aalves08 aalves08 force-pushed the 15597-update-shell-api-method-signatures branch from 3d2dd0a to 7c6fe46 Compare November 28, 2025 15:43
@aalves08 aalves08 requested a review from nwmac November 28, 2025 16:41
@aalves08 aalves08 force-pushed the 15597-update-shell-api-method-signatures branch from 57e7d92 to 6afcb18 Compare December 15, 2025 14:46
Copy link
Member

@nwmac nwmac left a comment

Choose a reason for hiding this comment

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

I think this is okay to get in - there are a few follow-ups to look at.

Need to work out between interfaces and types for some things. Some interfaces show up like EncryptedNotification that we probably don't want to see.

But, I'd suggest we get this in and iterate forward.

@aalves08 aalves08 merged commit 247ea9a into rancher:master Dec 16, 2025
60 of 62 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tech Debt: Create tests for Shell API implementation Tech Debt: Update Shell API's method signatures and enable typedoc integration

2 participants