fix: allow disabling operations in UI

[thephez]

Summary

Adds support for disabling operations in the UI without removing them from the codebase. Operations with a disabled property in api-definitions.json are shown with a "(Disabled)" suffix in the dropdown and display a warning message explaining why. Users can still view operation details, but the execute button is disabled.

Changes

• Add disabled property support to operation definitions in api-definitions.json
• Operations marked as disabled show "(Disabled)" suffix in dropdown
• Selecting a disabled operation shows a red warning banner with the disable reason
• Execute button is disabled for disabled operations
• Users can still click disabled operations to view their inputs and description
• Test utilities strip "(Disabled)" suffix so tests remain agnostic to disabled state

Disabled Operations

• getIdentitiesContractKeys - Requires fix for upstream issue #3028
• All platform address operations (queries and transitions) - Not fully implemented in SDK

Usage

To disable an operation, add a disabled property to its definition:

{
  "operationName": {
    "label": "Operation Label",
    "description": "...",
    "disabled": "Reason for disabling",
    "inputs": [...]
  }
}

Example:

Summary by CodeRabbit

• New Features

  • Nine API endpoints now display a disabled status with descriptive messages, preventing execution.
  • Disabled operations are marked in the interface dropdown and the execute button is disabled when unavailable.

• Style

  • Added visual styling for disabled warning states and disabled select options.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a disabled state mechanism for API endpoints. A "disabled" field is added to nine endpoints in the API definitions, with corresponding UI updates to display disabled status, prevent execution of disabled operations, and apply visual styling for the disabled state.

Changes

Cohort / File(s)	Summary
API Definitions Update public/api-definitions.json	Added a disabled field to 9 endpoints spanning identity and address categories: getIdentitiesContractKeys, getPlatformAddress, getPlatformAddresses, addressTransfer, addressTopUpIdentity, addressWithdraw, addressTransferFromIdentity, addressFundFromAssetLock, and addressCreateIdentity.
UI Implementation public/app.js, public/index.css	Updated populateOperations to append " (Disabled)" to disabled operation text; modified onOperationChange to display disabled reason in query description with warning styling and disable the execute button when operations are disabled. Added CSS classes for disabled warning appearance and disabled select options.
Test Utilities tests/e2e/utils/sdk-page.js	Updated getAvailableQueryTypes to strip the trailing " (Disabled)" suffix from operation options after filtering.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix: allow disabling operations in UI' accurately summarizes the main change: adding support for disabling operations in the UI while keeping them visible.

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

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/disable-api

---

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.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

public/app.js (1)

686-693: ⚠️ Potential issue | 🟡 Minor

Disabled options won’t appear greyed out.

You removed option.disabled to allow selection, but the CSS rule targets option:disabled, so the “disabled” styling won’t apply. Consider adding a data attribute/class to options and styling that instead.

🛠️ Proposed fix (keep selectable + add styling hook)

-    if (def?.disabled) {
-      // option.disabled = true; // Allow clicking to see operation details
-      option.textContent += ' (Disabled)';
-    }
+    if (def?.disabled) {
+      // option.disabled = true; // Allow clicking to see operation details
+      option.textContent += ' (Disabled)';
+      option.dataset.disabled = 'true';
+      option.setAttribute('aria-disabled', 'true');
+    }

- select option:disabled {
+ select option[data-disabled="true"] {
   color: `#999`;
 }

[PastaPastaPasta]

utACK