Skip to content

Commit

Permalink
Update docs by running build/sbt generate (unitycatalog#534)
Browse files Browse the repository at this point in the history
**PR Checklist**

- [x] A description of the changes is added to the description of this
PR.
- [x] If there is a related issue, make sure it is linked to this PR.
- [x] If you've fixed a bug or added code that should be tested, add
tests!
- [x] If you've added or modified a feature, documentation in `docs` is
updated

**Description of changes**

<!-- Please state what you've changed and how it might affect the users.
-->
Only run `build/sbt generate` to update the docs without any other
changes

Signed-off-by: Vikrant Puppala <vikrant.puppala@databricks.com>
  • Loading branch information
vikrantpuppala committed Oct 1, 2024
1 parent bf2dc18 commit 4c5e15e
Show file tree
Hide file tree
Showing 8 changed files with 131 additions and 0 deletions.
68 changes: 68 additions & 0 deletions api/Apis/GrantsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# GrantsApi

All URIs are relative to *http://localhost:8080/api/2.1/unity-catalog*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**get**](GrantsApi.md#get) | **GET** /permissions/{securable_type}/{full_name} | Get permissions |
| [**update**](GrantsApi.md#update) | **PATCH** /permissions/{securable_type}/{full_name} | Update a permission |


<a name="get"></a>
# **get**
> PermissionsList get(securable\_type, full\_name, principal)
Get permissions

Gets the permissions for a securable.

### Parameters

|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **securable\_type** | [**SecurableType**](../Models/.md)| Type of securable. | [default to null] [enum: metastore, catalog, schema, table, function, volume, registered_model] |
| **full\_name** | **String**| Full name of securable. | [default to null] |
| **principal** | **String**| If provided, only the permissions for the specified principal (user or group) are returned. | [optional] [default to null] |

### Return type

[**PermissionsList**](../Models/PermissionsList.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

<a name="update"></a>
# **update**
> PermissionsList update(securable\_type, full\_name, UpdatePermissions)
Update a permission

Updates the permissions for a securable.

### Parameters

|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **securable\_type** | [**SecurableType**](../Models/.md)| Type of securable. | [default to null] [enum: metastore, catalog, schema, table, function, volume, registered_model] |
| **full\_name** | **String**| Full name of securable. | [default to null] |
| **UpdatePermissions** | [**UpdatePermissions**](../Models/UpdatePermissions.md)| | [optional] |

### Return type

[**PermissionsList**](../Models/PermissionsList.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

11 changes: 11 additions & 0 deletions api/Models/PermissionsChange.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# PermissionsChange
## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **principal** | **String** | The principal whose privileges we are changing. | [default to null] |
| **add** | [**List**](Privilege.md) | The set of privileges to add. | [default to null] |
| **remove** | [**List**](Privilege.md) | The set of privileges to remove. | [default to null] |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions api/Models/PermissionsList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# PermissionsList
## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **privilege\_assignments** | [**List**](PrivilegeAssignment.md) | The privileges assigned to each principal. | [default to null] |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8 changes: 8 additions & 0 deletions api/Models/PrincipalType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# PrincipalType
## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8 changes: 8 additions & 0 deletions api/Models/Privilege.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Privilege
## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions api/Models/PrivilegeAssignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# PrivilegeAssignment
## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **principal** | **String** | The principal (user email address or group name). | [default to null] |
| **privileges** | [**List**](Privilege.md) | The privileges assigned to the principal. | [default to null] |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8 changes: 8 additions & 0 deletions api/Models/SecurableType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# SecurableType
## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9 changes: 9 additions & 0 deletions api/Models/UpdatePermissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# UpdatePermissions
## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **changes** | [**List**](PermissionsChange.md) | Array of permissions change objects. | [default to null] |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 comments on commit 4c5e15e

Please sign in to comment.