Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ISSUE] missing documentation for permissions API #481

Open
imarkowitz opened this issue Dec 13, 2023 · 2 comments
Open

[ISSUE] missing documentation for permissions API #481

imarkowitz opened this issue Dec 13, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation OpenAPI issues related to metadata across all SDKs

Comments

@imarkowitz
Copy link

imarkowitz commented Dec 13, 2023

Description

There's no documentation here:

instead it just says <needs content>.

This API really needs documentation. What is a request_object_type and what are possible values here?

I'm trying to update permissions for a python wheel and I have no idea what the type string should be.

@hectorcast-db
Copy link
Contributor

Hi @imarkowitz
Thanks for reaching out. We will improve the documentations for this object.
However, most likely you are looking for a different object.
This is the generic permissions class, but there are classes and methods dedicated to handle permissions for each Databricks resource. For instance, here the objects and methods to get the permissions for a Job

def get_permission_levels(self, job_id: str) -> GetJobPermissionLevelsResponse:

@imarkowitz
Copy link
Author

Thanks, I think it would be helpful to add that information to the documentation as well.

Documentation on those APIs seems inadequate as well. For example,

The workspace object type for which to get or manage permissions.
-- what are valid possible values for "workspace_object_type" here?

Thanks

@mgyucht mgyucht added documentation Improvements or additions to documentation OpenAPI issues related to metadata across all SDKs labels Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation OpenAPI issues related to metadata across all SDKs
Projects
None yet
Development

No branches or pull requests

3 participants