databricks-sdk-py icon indicating copy to clipboard operation
databricks-sdk-py copied to clipboard

[ISSUE] GroupsAPI.list uses displayName rather than display_name with no documentation

Open NorthernScott opened this issue 4 months ago • 0 comments

Description The databricks.sdk.service.iam.Group class definition gives the "display name" attribute as display_name. However, the databricks.sdk.service.iam.GroupsAPI.list method uses the notation displayName.

In addition to the inconsistency, the allowable attribute values that can be passed to GroupsAPI.list are not documented.

Reproduction payload = w.groups.list(attributes="id,display_name,meta,entitlements,groups", sort_by="id")

returns all expected data except display_name, giving only nulls.

payload = w.groups.list(attributes="id,displayName,meta,entitlements,groups", sort_by="id")

returns all expected data including displayName.

Expected behavior

  1. The GroupsAPI.list method should use the same nomenclature as the Groups class.
  2. The documentation should be updated to provide a list of allowable values.
  3. Could the API be updated to return a helpful error message if an invalid attribute is passed?

Is it a regression? I don't know.

Debug Logs 2025-08-20 20:46:51,364 - py4j.clientserver - DEBUG - Command to send: c o406 logExecuteCommandEvent sDATABRICKS_SHELL_DO_EXECUTE_START n e

2025-08-20 20:46:51,367 - py4j.clientserver - DEBUG - Answer received: !yv 2025-08-20 20:46:51,370 - py4j.clientserver - DEBUG - Command to send: c o406 logExecuteCommandEvent sSWAP_REMOTE_SPARK_CLIENT n e

2025-08-20 20:46:51,384 - py4j.clientserver - DEBUG - Answer received: !yv 2025-08-20 20:46:51,390 - databricks.sdk - DEBUG - /home/spark-3e31d39d-3197-4574-a7ea-e1/.databrickscfg does not exist 2025-08-20 20:46:51,391 - databricks.sdk - DEBUG - Attempting to configure auth: pat 2025-08-20 20:46:51,401 - databricks.sdk - DEBUG - Attempting to configure auth: basic 2025-08-20 20:46:51,402 - databricks.sdk - DEBUG - Attempting to configure auth: metadata-service 2025-08-20 20:46:51,403 - databricks.sdk - DEBUG - Attempting to configure auth: oauth-m2m 2025-08-20 20:46:51,405 - databricks.sdk - DEBUG - Attempting to configure auth: azure-client-secret 2025-08-20 20:46:51,407 - databricks.sdk - DEBUG - Attempting to configure auth: github-oidc-azure 2025-08-20 20:46:51,408 - databricks.sdk - DEBUG - Attempting to configure auth: azure-cli 2025-08-20 20:46:51,409 - databricks.sdk - DEBUG - Attempting to configure auth: external-browser 2025-08-20 20:46:51,410 - databricks.sdk - DEBUG - Attempting to configure auth: databricks-cli 2025-08-20 20:46:51,416 - databricks.sdk - DEBUG - Attempting to configure auth: runtime 2025-08-20 20:46:51,416 - databricks.sdk - DEBUG - [init_runtime_native_auth] runtime native auth configured 2025-08-20 20:46:51,433 - py4j.clientserver - DEBUG - Command to send: c o392 contains sspark.databricks.workspaceUrl e

2025-08-20 20:46:51,434 - py4j.clientserver - DEBUG - Answer received: !ybfalse 2025-08-20 20:46:51,436 - py4j.clientserver - DEBUG - Command to send: c o392 contains sspark.databricks.clusterUsageTags.sparkVersion e

2025-08-20 20:46:51,437 - py4j.clientserver - DEBUG - Answer received: !ybtrue 2025-08-20 20:46:51,442 - py4j.clientserver - DEBUG - Command to send: c o392 contains sspark.databricks.clusterUsageTags.sparkVersion e

2025-08-20 20:46:51,452 - py4j.clientserver - DEBUG - Answer received: !ybtrue 2025-08-20 20:46:51,458 - py4j.clientserver - DEBUG - Command to send: c o392 get sspark.databricks.clusterUsageTags.sparkVersion e

2025-08-20 20:46:51,460 - py4j.clientserver - DEBUG - Answer received: !ysclient.1.13-scala2.12 2025-08-20 20:46:51,461 - py4j.clientserver - DEBUG - Command to send: c o406 logExecuteCommandEvent sDATABRICKS_SHELL_DO_EXECUTE_END n e

2025-08-20 20:46:51,469 - py4j.clientserver - DEBUG - Answer received: !yv

Other Information

  • OS: Windows 11
  • Build: 22631.5624
  • FP: Windows Feature Experience Pack 1000.22700.1106.0

Additional context

I am running the SDK alongside the Databricks-Connect extension and Databricks-CLI.

NorthernScott avatar Aug 20 '25 20:08 NorthernScott