Add metastore API spec

.gitignore

@@ -22,4 +22,7 @@ python_engine.log
 # Signing keys and access tokens
 etc/conf/certs.json
 etc/conf/*.txt
-etc/conf/*.der
+etc/conf/*.der
+connectors/spark/etc/conf/certs.json
+connectors/spark/etc/conf/*.txt
+connectors/spark/etc/conf/*.der

Dockerfile

@@ -62,7 +62,7 @@ ARG sbt_args
 ARG unitycatalog_version
 ARG jars_directory
 
-EXPOSE 8081
+EXPOSE 8080 8081
 
 RUN <<EOF
     set -ex;

README.md

@@ -151,15 +151,18 @@ To quit DuckDB, press `Ctrl`+`D` (if your platform supports it), press `Ctrl`+`C
 
 To use the Unity Catalog UI, start a new terminal and ensure you have already started the UC server (e.g., `./bin/start-uc-server`)
 
+**Prerequisites**
+* Node: https://nodejs.org/en/download/package-manager
+* Yarn: https://classic.yarnpkg.com/lang/en/docs/install
+
+**How to start the UI through yarn**
 ```
 cd /ui
 yarn install
 yarn start
-open localhost:3000
 ```
 
 
-
 ## CLI tutorial
 
 You can interact with a Unity Catalog server to create and manage catalogs, schemas and tables,
@@ -168,7 +171,7 @@ See the [cli usage](docs/usage/cli.md) for more details.
 
 ## APIs and Compatibility
 
-- Open API specification: The Unity Catalog Rest API is documented [here](api).
+- Open API specification: See the [Unity Catalog Rest API](https://docs.unitycatalog.io/swagger-docs/).
 - Compatibility and stability: The APIs are currently evolving and should not be assumed to be stable.
 
 ## Building Unity Catalog

api/Apis/GrantsApi.md

@@ -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
+

api/Apis/MetastoresApi.md

@@ -0,0 +1,33 @@
+# MetastoresApi
+
+All URIs are relative to *http://localhost:8080/api/2.1/unity-catalog*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**summary**](MetastoresApi.md#summary) | **GET** /metastore_summary | Get metastore summary |
+
+
+<a name="summary"></a>
+# **summary**
+> GetMetastoreSummaryResponse summary()
+
+Get metastore summary
+
+    Gets information about the metastore hosted by this Unity Catalog service (currently the service hosts only one metastore) 
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetMetastoreSummaryResponse**](../Models/GetMetastoreSummaryResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

api/Apis/ModelVersionsApi.md

@@ -0,0 +1,184 @@
+# ModelVersionsApi
+
+All URIs are relative to *http://localhost:8080/api/2.1/unity-catalog*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createModelVersion**](ModelVersionsApi.md#createModelVersion) | **POST** /models/versions | Create a model version.  |
+| [**deleteModelVersion**](ModelVersionsApi.md#deleteModelVersion) | **DELETE** /models/{full_name}/versions/{version} | Delete a model version |
+| [**finalizeModelVersion**](ModelVersionsApi.md#finalizeModelVersion) | **PATCH** /models/{full_name}/versions/{version}/finalize | Finalize a model version |
+| [**getModelVersion**](ModelVersionsApi.md#getModelVersion) | **GET** /models/{full_name}/versions/{version} | Get a model version |
+| [**listModelVersions**](ModelVersionsApi.md#listModelVersions) | **GET** /models/{full_name}/versions | List model versions of the specified registered model. |
+| [**updateModelVersion**](ModelVersionsApi.md#updateModelVersion) | **PATCH** /models/{full_name}/versions/{version} | Update a model version |
+
+
+<a name="createModelVersion"></a>
+# **createModelVersion**
+> ModelVersionInfo createModelVersion(CreateModelVersion)
+
+Create a model version. 
+
+    Creates a new model version instance. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **CreateModelVersion** | [**CreateModelVersion**](../Models/CreateModelVersion.md)|  | [optional] |
+
+### Return type
+
+[**ModelVersionInfo**](../Models/ModelVersionInfo.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+<a name="deleteModelVersion"></a>
+# **deleteModelVersion**
+> oas_any_type_not_mapped deleteModelVersion(full\_name, version)
+
+Delete a model version
+
+    Deletes the specified model version. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **full\_name** | **String**| Full name of the model. | [default to null] |
+| **version** | **Long**| Version number of the model version. | [default to null] |
+
+### Return type
+
+[**oas_any_type_not_mapped**](../Models/AnyType.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="finalizeModelVersion"></a>
+# **finalizeModelVersion**
+> ModelVersionInfo finalizeModelVersion(full\_name, version, FinalizeModelVersion)
+
+Finalize a model version
+
+    Finalizes the status of the specified model version. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **full\_name** | **String**| Full name of the model. | [default to null] |
+| **version** | **Long**| Version number of the model version. | [default to null] |
+| **FinalizeModelVersion** | [**FinalizeModelVersion**](../Models/FinalizeModelVersion.md)|  | [optional] |
+
+### Return type
+
+[**ModelVersionInfo**](../Models/ModelVersionInfo.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+<a name="getModelVersion"></a>
+# **getModelVersion**
+> ModelVersionInfo getModelVersion(full\_name, version)
+
+Get a model version
+
+    Gets a specific model version for a specific model. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **full\_name** | **String**| Full name of the model. | [default to null] |
+| **version** | **Long**| Version number of the model version. | [default to null] |
+
+### Return type
+
+[**ModelVersionInfo**](../Models/ModelVersionInfo.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="listModelVersions"></a>
+# **listModelVersions**
+> ListModelVersionsResponse listModelVersions(full\_name, max\_results, page\_token)
+
+List model versions of the specified registered model.
+
+    Gets the paginated list of all available model versions under the specified registered model. There is no guarantee of a specific ordering of the elements in the array. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **full\_name** | **String**| Full name of the registered model. | [default to null] |
+| **max\_results** | **Integer**| Maximum number of model versions to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned;  | [optional] [default to null] |
+| **page\_token** | **String**| Opaque token to send for the next page of results (pagination). | [optional] [default to null] |
+
+### Return type
+
+[**ListModelVersionsResponse**](../Models/ListModelVersionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="updateModelVersion"></a>
+# **updateModelVersion**
+> ModelVersionInfo updateModelVersion(full\_name, version, UpdateModelVersion)
+
+Update a model version
+
+    Updates the specified model version. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **full\_name** | **String**| Full name of the model. | [default to null] |
+| **version** | **Long**| Version number of the model version. | [default to null] |
+| **UpdateModelVersion** | [**UpdateModelVersion**](../Models/UpdateModelVersion.md)|  | [optional] |
+
+### Return type
+
+[**ModelVersionInfo**](../Models/ModelVersionInfo.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+