Skip to content

[DX] GAP-13: bindings.json scaffolded empty with no auto-population and no guidance on required values #1501

Description

@AlexBizon

Summary

uipath init creates bindings.json with an empty resources array and no guidance. uipath pack bundles the empty file as-is. The SDK makes no attempt to detect the resources (buckets, connections, entities) used by the code, and there is no documentation explaining how to find the required keys/GUIDs.

Root Cause

uipath init only creates bindings.json if it does not already exist, with:

{ "version": "2.0", "resources": [] }

uipath pack bundles whatever is in the file without analyzing the code for SDK calls. The bindings.spec.md describes the schema but provides no guidance on discovering which keys/GUIDs to use.

What a Complete bindings.json Looks Like

{
    "version": "2.0",
    "resources": [
        {
            "resource": "bucket",
            "key": "Invoices",
            "value": {
                "name": { "defaultValue": "Invoices" },
                "folderPath": { "defaultValue": "Shared/Solution Invoice App" }
            },
            "metadata": { "BindingsVersion": "2.2" }
        },
        {
            "resource": "connection",
            "key": "6fba04c7-1d0e-4393-adec-705e858ff67a",
            "value": {
                "ConnectionId": { "defaultValue": "6fba04c7-1d0e-4393-adec-705e858ff67a" }
            },
            "metadata": {
                "BindingsVersion": "2.2",
                "Connector": "uipath-salesforce-sfdc",
                "UseConnectionService": "True"
            }
        }
    ]
}

Getting to this required: finding connection UUIDs in the Orchestrator UI, calling the Integration Service API to get connector technical keys, reading the bindings spec to understand the schema structure.

Suggested Fix

  1. Preferred: uipath init scans for sdk.buckets.*, sdk.connections.*, sdk.entities.* calls and generates stub entries with placeholder keys.
  2. Alternative: uipath bindings add CLI command that interactively adds resource entries.
  3. Minimum: Add a comment/example in the generated file and a link to documentation explaining the schema and where to find connection GUIDs.

Related Issues

  • GAP-21: metadata.Connector must be the technical key (e.g. uipath-salesforce-sfdc), not the display name
  • GAP-22: folderPath cannot be empty in bucket bindings

Impact

  • Severity: Medium
  • Every project using buckets, connections, or entities requires manual bindings.json population
  • Required values (connector technical keys, connection UUIDs) are hard to discover without separate API calls

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions