databricks/databricks-sdk-py

[ISSUE] Inconsistent API design in ServingEndpointAccessControlRequest

moritzmeister opened this issue · 0 comments

moritzmeister commented

Description
The API design of the ServingEndpointAccessControlRequest class is inconsistent.

The argument is called service_principal_name but it is actually the application id of the service principal that is needed. The documentation mentions it but it's still confusing and inconsistent.

https://databricks-sdk-py.readthedocs.io/en/latest/dbdataclasses/serving.html#databricks.sdk.service.serving.ServingEndpointAccessControlRequest.service_principal_name

Reproduction
Easy to reproduce just try to set permissions with a an actual service principal name.

Expected behavior
Being able to set a service principal name instead of the id. More readable and consistent with the name of the argument.

Other Information

  • OS: DBR 15.2
  • Version: 0.28.0