1  syntax = "proto2";
  2  
  3  package mlflow.unitycatalog;
  4  
  5  import "databricks.proto";
  6  import "scalapb/scalapb.proto";
  7  import "unity_catalog_oss_messages.proto";
  8  
  9  option java_generate_equals_and_hash = true;
 10  option java_package = "com.databricks.api.proto.managedcatalog";
 11  option py_generic_services = true;
 12  option (scalapb.options) = {flat_package: true};
 13  
 14  service UnityCatalogService {
 15    // Registered Model Management API
 16    rpc createRegisteredModel(CreateRegisteredModel) returns (CreateRegisteredModel.Response) {
 17      option (rpc) = {
 18        endpoints: {
 19          method: "POST"
 20          path: "/unity-catalog/models"
 21          since: {
 22            major: 2
 23            minor: 1
 24          }
 25        }
 26        // https://docs.databricks.com/api/workspace/registeredmodels/create
 27        visibility: PUBLIC
 28      };
 29    }
 30  
 31    rpc updateRegisteredModel(UpdateRegisteredModel) returns (UpdateRegisteredModel.Response) {
 32      option (rpc) = {
 33        endpoints: {
 34          method: "PATCH"
 35          path: "/unity-catalog/models/{full_name}"
 36          since: {
 37            major: 2
 38            minor: 1
 39          }
 40        }
 41        visibility: PUBLIC_UNDOCUMENTED
 42      };
 43    }
 44  
 45    rpc deleteRegisteredModel(DeleteRegisteredModel) returns (DeleteRegisteredModel.Response) {
 46      option (rpc) = {
 47        endpoints: {
 48          method: "DELETE"
 49          path: "/unity-catalog/models/{full_name}"
 50          since: {
 51            major: 2
 52            minor: 1
 53          }
 54        }
 55        visibility: PUBLIC_UNDOCUMENTED
 56      };
 57    }
 58  
 59    rpc getRegisteredModel(GetRegisteredModel) returns (GetRegisteredModel.Response) {
 60      option idempotency_level = IDEMPOTENT;
 61      option (rpc) = {
 62        endpoints: {
 63          method: "GET"
 64          path: "/unity-catalog/models/{full_name}"
 65          since: {
 66            major: 2
 67            minor: 1
 68          }
 69        }
 70        visibility: PUBLIC_UNDOCUMENTED
 71      };
 72    }
 73  
 74    rpc getModelVersion(GetModelVersion) returns (GetModelVersion.Response) {
 75      option idempotency_level = IDEMPOTENT;
 76      option (rpc) = {
 77        endpoints: {
 78          method: "GET"
 79          path: "/unity-catalog/models/{full_name}/versions/{version}"
 80          since: {
 81            major: 2
 82            minor: 1
 83          }
 84        }
 85        visibility: PUBLIC_UNDOCUMENTED
 86      };
 87    }
 88  
 89    rpc deleteModelVersion(DeleteModelVersion) returns (DeleteModelVersion.Response) {
 90      option (rpc) = {
 91        endpoints: {
 92          method: "DELETE"
 93          path: "/unity-catalog/models/{full_name}/versions/{version}"
 94          since: {
 95            major: 2
 96            minor: 1
 97          }
 98        }
 99        visibility: PUBLIC_UNDOCUMENTED
100      };
101    }
102  
103    rpc createModelVersion(CreateModelVersion) returns (CreateModelVersion.Response) {
104      option (rpc) = {
105        endpoints: {
106          method: "POST"
107          path: "/unity-catalog/models/versions"
108          since: {
109            major: 2
110            minor: 1
111          }
112        }
113      };
114    }
115  
116    rpc generateTemporaryModelVersionCredential(GenerateTemporaryModelVersionCredential) returns (GenerateTemporaryModelVersionCredential.Response) {
117      option (rpc) = {
118        endpoints: {
119          method: "POST"
120          path: "/unity-catalog/temporary-model-version-credentials"
121          since: {
122            major: 2
123            minor: 1
124          }
125        }
126        visibility: PUBLIC_UNDOCUMENTED
127      };
128    }
129  
130    rpc finalizeModelVersion(FinalizeModelVersion) returns (FinalizeModelVersion.Response) {
131      option (rpc) = {
132        endpoints: {
133          method: "PATCH"
134          path: "/unity-catalog/models/{full_name}/versions/{version}/finalize"
135          since: {
136            major: 2
137            minor: 1
138          }
139        }
140        visibility: PUBLIC_UNDOCUMENTED
141      };
142    }
143  
144    rpc updateModelVersion(UpdateModelVersion) returns (UpdateModelVersion.Response) {
145      option (rpc) = {
146        endpoints: {
147          method: "PATCH"
148          path: "/unity-catalog/models/{full_name}/versions/{version}"
149          since: {
150            major: 2
151            minor: 1
152          }
153        }
154        visibility: PUBLIC_UNDOCUMENTED
155      };
156    }
157  
158    rpc listRegisteredModels(ListRegisteredModels) returns (ListRegisteredModels.Response) {
159      option idempotency_level = IDEMPOTENT;
160      option (rpc) = {
161        endpoints: {
162          method: "GET"
163          path: "/unity-catalog/models"
164          since: {
165            major: 2
166            minor: 1
167          }
168        }
169        visibility: PUBLIC_UNDOCUMENTED
170      };
171    }
172  
173    rpc listModelVersions(ListModelVersions) returns (ListModelVersions.Response) {
174      option idempotency_level = IDEMPOTENT;
175      option (rpc) = {
176        endpoints: {
177          method: "GET"
178          path: "/unity-catalog/models/{full_name}/versions"
179          since: {
180            major: 2
181            minor: 1
182          }
183        }
184        visibility: PUBLIC_UNDOCUMENTED
185      };
186    }
187  }