address review comments

yanghua · yanghua · commit 31fbc33706c0 · 2025-04-21T21:45:33.000+08:00
diff --git a/java/lance-catalog-apache-client/.openapi-generator/FILES b/java/lance-catalog-apache-client/.openapi-generator/FILES
@@ -5,7 +5,7 @@ docs/CreateNamespaceRequest.md
 docs/CreateNamespaceResponse.md
 docs/ErrorModel.md
 docs/GetNamespaceResponse.md
-docs/GetTableResult.md
+docs/GetTableResponse.md
 docs/ListNamespacesResponse.md
 docs/NamespaceApi.md
 pom.xml
@@ -29,5 +29,5 @@ src/main/java/com/lancedb/lance/catalog/client/apache/model/CreateNamespaceReque
 src/main/java/com/lancedb/lance/catalog/client/apache/model/CreateNamespaceResponse.java
 src/main/java/com/lancedb/lance/catalog/client/apache/model/ErrorModel.java
 src/main/java/com/lancedb/lance/catalog/client/apache/model/GetNamespaceResponse.java
-src/main/java/com/lancedb/lance/catalog/client/apache/model/GetTableResult.java
+src/main/java/com/lancedb/lance/catalog/client/apache/model/GetTableResponse.java
 src/main/java/com/lancedb/lance/catalog/client/apache/model/ListNamespacesResponse.java
diff --git a/java/lance-catalog-apache-client/README.md b/java/lance-catalog-apache-client/README.md
@@ -128,7 +128,7 @@ Class | Method | HTTP request | Description
  - [CreateNamespaceResponse](docs/CreateNamespaceResponse.md)
  - [ErrorModel](docs/ErrorModel.md)
  - [GetNamespaceResponse](docs/GetNamespaceResponse.md)
- - [GetTableResult](docs/GetTableResult.md)
+ - [GetTableResponse](docs/GetTableResponse.md)
  - [ListNamespacesResponse](docs/ListNamespacesResponse.md)
 
 
diff --git a/java/lance-catalog-apache-client/api/openapi.yaml b/java/lance-catalog-apache-client/api/openapi.yaml
@@ -268,7 +268,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/GetTableResult'
+            $ref: '#/components/schemas/GetTableResponse'
       description: Table properties result when loading a table
     BadRequestErrorResponse:
       content:
@@ -473,7 +473,7 @@ components:
           nullable: true
       required:
       - namespace
-    GetTableResult:
+    GetTableResponse:
       description: |
         Result used when a table is successfully loaded.
       example:
diff --git a/java/lance-catalog-apache-client/docs/GetTableResponse.md b/java/lance-catalog-apache-client/docs/GetTableResponse.md
@@ -1,6 +1,6 @@
 
 
-# GetTableResult
+# GetTableResponse
 
 Result used when a table is successfully loaded. 
 
diff --git a/java/lance-catalog-apache-client/docs/NamespaceApi.md b/java/lance-catalog-apache-client/docs/NamespaceApi.md
@@ -226,7 +226,7 @@ No authorization required
 
 ## getTable
 
-> GetTableResult getTable(ns, table)
+> GetTableResponse getTable(ns, table)
 
 Get a table from the catalog
 
@@ -251,7 +251,7 @@ public class Example {
         String ns = "ns_example"; // String | The name of the namespace.
         String table = "table_example"; // String | A table name.
         try {
-            GetTableResult result = apiInstance.getTable(ns, table);
+            GetTableResponse result = apiInstance.getTable(ns, table);
             System.out.println(result);
         } catch (ApiException e) {
             System.err.println("Exception when calling NamespaceApi#getTable");
@@ -274,7 +274,7 @@ public class Example {
 
 ### Return type
 
-[**GetTableResult**](GetTableResult.md)
+[**GetTableResponse**](GetTableResponse.md)
 
 ### Authorization
 
diff --git a/java/lance-catalog-apache-client/src/main/java/com/lancedb/lance/catalog/client/apache/api/NamespaceApi.java b/java/lance-catalog-apache-client/src/main/java/com/lancedb/lance/catalog/client/apache/api/NamespaceApi.java
@@ -21,7 +21,7 @@
 import com.lancedb.lance.catalog.client.apache.model.CreateNamespaceRequest;
 import com.lancedb.lance.catalog.client.apache.model.CreateNamespaceResponse;
 import com.lancedb.lance.catalog.client.apache.model.GetNamespaceResponse;
-import com.lancedb.lance.catalog.client.apache.model.GetTableResult;
+import com.lancedb.lance.catalog.client.apache.model.GetTableResponse;
 import com.lancedb.lance.catalog.client.apache.model.ListNamespacesResponse;
 
 import com.fasterxml.jackson.core.type.TypeReference;
@@ -274,10 +274,10 @@ public GetNamespaceResponse getNamespace(String ns, Map<String, String> addition
    *
    * @param ns The name of the namespace. (required)
    * @param table A table name. (required)
-   * @return GetTableResult
+   * @return GetTableResponse
    * @throws ApiException if fails to make API call
    */
-  public GetTableResult getTable(String ns, String table) throws ApiException {
+  public GetTableResponse getTable(String ns, String table) throws ApiException {
     return this.getTable(ns, table, Collections.emptyMap());
   }
 
@@ -288,10 +288,10 @@ public GetTableResult getTable(String ns, String table) throws ApiException {
    * @param ns The name of the namespace. (required)
    * @param table A table name. (required)
    * @param additionalHeaders additionalHeaders for this call
-   * @return GetTableResult
+   * @return GetTableResponse
    * @throws ApiException if fails to make API call
    */
-  public GetTableResult getTable(String ns, String table, Map<String, String> additionalHeaders)
+  public GetTableResponse getTable(String ns, String table, Map<String, String> additionalHeaders)
       throws ApiException {
     Object localVarPostBody = null;
 
@@ -333,7 +333,7 @@ public GetTableResult getTable(String ns, String table, Map<String, String> addi
 
     String[] localVarAuthNames = new String[] {};
 
-    TypeReference<GetTableResult> localVarReturnType = new TypeReference<GetTableResult>() {};
+    TypeReference<GetTableResponse> localVarReturnType = new TypeReference<GetTableResponse>() {};
     return apiClient.invokeAPI(
         localVarPath,
         "GET",
diff --git a/java/lance-catalog-apache-client/src/main/java/com/lancedb/lance/catalog/client/apache/model/GetTableResponse.java b/java/lance-catalog-apache-client/src/main/java/com/lancedb/lance/catalog/client/apache/model/GetTableResponse.java
@@ -25,23 +25,23 @@
 import java.util.StringJoiner;
 
 /** Result used when a table is successfully loaded. */
-@JsonPropertyOrder({GetTableResult.JSON_PROPERTY_PROPERTIES})
+@JsonPropertyOrder({GetTableResponse.JSON_PROPERTY_PROPERTIES})
 @javax.annotation.Generated(
     value = "org.openapitools.codegen.languages.JavaClientCodegen",
     comments = "Generator version: 7.12.0")
-public class GetTableResult {
+public class GetTableResponse {
   public static final String JSON_PROPERTY_PROPERTIES = "properties";
   @javax.annotation.Nullable private Map<String, String> properties = new HashMap<>();
 
-  public GetTableResult() {}
+  public GetTableResponse() {}
 
-  public GetTableResult properties(@javax.annotation.Nullable Map<String, String> properties) {
+  public GetTableResponse properties(@javax.annotation.Nullable Map<String, String> properties) {
 
     this.properties = properties;
     return this;
   }
 
-  public GetTableResult putPropertiesItem(String key, String propertiesItem) {
+  public GetTableResponse putPropertiesItem(String key, String propertiesItem) {
     if (this.properties == null) {
       this.properties = new HashMap<>();
     }
@@ -75,8 +75,8 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
-    GetTableResult getTableResult = (GetTableResult) o;
-    return Objects.equals(this.properties, getTableResult.properties);
+    GetTableResponse getTableResponse = (GetTableResponse) o;
+    return Objects.equals(this.properties, getTableResponse.properties);
   }
 
   @Override
@@ -87,7 +87,7 @@ public int hashCode() {
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
-    sb.append("class GetTableResult {\n");
+    sb.append("class GetTableResponse {\n");
     sb.append("    properties: ").append(toIndentedString(properties)).append("\n");
     sb.append("}");
     return sb.toString();
diff --git a/java/lance-catalog-springboot-server/.openapi-generator/FILES b/java/lance-catalog-springboot-server/.openapi-generator/FILES
@@ -7,5 +7,5 @@ src/main/java/com/lancedb/lance/catalog/server/springboot/model/CreateNamespaceR
 src/main/java/com/lancedb/lance/catalog/server/springboot/model/CreateNamespaceResponse.java
 src/main/java/com/lancedb/lance/catalog/server/springboot/model/ErrorModel.java
 src/main/java/com/lancedb/lance/catalog/server/springboot/model/GetNamespaceResponse.java
-src/main/java/com/lancedb/lance/catalog/server/springboot/model/GetTableResult.java
+src/main/java/com/lancedb/lance/catalog/server/springboot/model/GetTableResponse.java
 src/main/java/com/lancedb/lance/catalog/server/springboot/model/ListNamespacesResponse.java
diff --git a/java/lance-catalog-springboot-server/src/main/java/com/lancedb/lance/catalog/server/springboot/api/NamespaceApi.java b/java/lance-catalog-springboot-server/src/main/java/com/lancedb/lance/catalog/server/springboot/api/NamespaceApi.java
@@ -17,7 +17,7 @@
 import com.lancedb.lance.catalog.server.springboot.model.CreateNamespaceResponse;
 import com.lancedb.lance.catalog.server.springboot.model.ErrorModel;
 import com.lancedb.lance.catalog.server.springboot.model.GetNamespaceResponse;
-import com.lancedb.lance.catalog.server.springboot.model.GetTableResult;
+import com.lancedb.lance.catalog.server.springboot.model.GetTableResponse;
 import com.lancedb.lance.catalog.server.springboot.model.ListNamespacesResponse;
 
 import io.swagger.v3.oas.annotations.Operation;
@@ -522,7 +522,7 @@ default ResponseEntity<GetNamespaceResponse> getNamespace(
             content = {
               @Content(
                   mediaType = "application/json",
-                  schema = @Schema(implementation = GetTableResult.class))
+                  schema = @Schema(implementation = GetTableResponse.class))
             }),
         @ApiResponse(
             responseCode = "400",
@@ -572,7 +572,7 @@ default ResponseEntity<GetNamespaceResponse> getNamespace(
       method = RequestMethod.GET,
       value = "/v1/namespaces/{ns}/tables/{table}",
       produces = {"application/json"})
-  default ResponseEntity<GetTableResult> getTable(
+  default ResponseEntity<GetTableResponse> getTable(
       @Parameter(
               name = "ns",
               description = "The name of the namespace.",
diff --git a/java/lance-catalog-springboot-server/src/main/java/com/lancedb/lance/catalog/server/springboot/model/GetTableResponse.java b/java/lance-catalog-springboot-server/src/main/java/com/lancedb/lance/catalog/server/springboot/model/GetTableResponse.java
@@ -26,20 +26,22 @@
 import java.util.Objects;
 
 /** Result used when a table is successfully loaded. */
-@Schema(name = "GetTableResult", description = "Result used when a table is successfully loaded. ")
+@Schema(
+    name = "GetTableResponse",
+    description = "Result used when a table is successfully loaded. ")
 @Generated(
     value = "org.openapitools.codegen.languages.SpringCodegen",
     comments = "Generator version: 7.12.0")
-public class GetTableResult {
+public class GetTableResponse {
 
   @Valid private Map<String, String> properties = new HashMap<>();
 
-  public GetTableResult properties(Map<String, String> properties) {
+  public GetTableResponse properties(Map<String, String> properties) {
     this.properties = properties;
     return this;
   }
 
-  public GetTableResult putPropertiesItem(String key, String propertiesItem) {
+  public GetTableResponse putPropertiesItem(String key, String propertiesItem) {
     if (this.properties == null) {
       this.properties = new HashMap<>();
     }
@@ -70,8 +72,8 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) {
       return false;
     }
-    GetTableResult getTableResult = (GetTableResult) o;
-    return Objects.equals(this.properties, getTableResult.properties);
+    GetTableResponse getTableResponse = (GetTableResponse) o;
+    return Objects.equals(this.properties, getTableResponse.properties);
   }
 
   @Override
@@ -82,7 +84,7 @@ public int hashCode() {
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
-    sb.append("class GetTableResult {\n");
+    sb.append("class GetTableResponse {\n");
     sb.append("    properties: ").append(toIndentedString(properties)).append("\n");
     sb.append("}");
     return sb.toString();
diff --git a/rust/lance-catalog-reqwest-client/.openapi-generator/FILES b/rust/lance-catalog-reqwest-client/.openapi-generator/FILES
@@ -6,7 +6,7 @@ docs/CreateNamespaceRequest.md
 docs/CreateNamespaceResponse.md
 docs/ErrorModel.md
 docs/GetNamespaceResponse.md
-docs/GetTableResult.md
+docs/GetTableResponse.md
 docs/ListNamespacesResponse.md
 docs/NamespaceApi.md
 git_push.sh
@@ -18,6 +18,6 @@ src/models/create_namespace_request.rs
 src/models/create_namespace_response.rs
 src/models/error_model.rs
 src/models/get_namespace_response.rs
-src/models/get_table_result.rs
+src/models/get_table_response.rs
 src/models/list_namespaces_response.rs
 src/models/mod.rs
diff --git a/rust/lance-catalog-reqwest-client/README.md b/rust/lance-catalog-reqwest-client/README.md
@@ -46,7 +46,7 @@ Class | Method | HTTP request | Description
  - [CreateNamespaceResponse](docs/CreateNamespaceResponse.md)
  - [ErrorModel](docs/ErrorModel.md)
  - [GetNamespaceResponse](docs/GetNamespaceResponse.md)
- - [GetTableResult](docs/GetTableResult.md)
+ - [GetTableResponse](docs/GetTableResponse.md)
  - [ListNamespacesResponse](docs/ListNamespacesResponse.md)
 
 
diff --git a/rust/lance-catalog-reqwest-client/docs/GetTableResponse.md b/rust/lance-catalog-reqwest-client/docs/GetTableResponse.md
@@ -1,4 +1,4 @@
-# GetTableResult
+# GetTableResponse
 
 ## Properties
 
diff --git a/rust/lance-catalog-reqwest-client/docs/NamespaceApi.md b/rust/lance-catalog-reqwest-client/docs/NamespaceApi.md
@@ -101,7 +101,7 @@ No authorization required
 
 ## get_table
 
-> models::GetTableResult get_table(ns, table)
+> models::GetTableResponse get_table(ns, table)
 Get a table from the catalog
 
 Get a table's detailed properties under a specified namespace from the catalog.\".
@@ -116,7 +116,7 @@ Name | Type | Description  | Required | Notes
 
 ### Return type
 
-[**models::GetTableResult**](GetTableResult.md)
+[**models::GetTableResponse**](GetTableResponse.md)
 
 ### Authorization
 
diff --git a/rust/lance-catalog-reqwest-client/src/apis/namespace_api.rs b/rust/lance-catalog-reqwest-client/src/apis/namespace_api.rs
@@ -193,7 +193,7 @@ pub async fn get_namespace(configuration: &configuration::Configuration, ns: &st
 }
 
 /// Get a table's detailed properties under a specified namespace from the catalog.\".
-pub async fn get_table(configuration: &configuration::Configuration, ns: &str, table: &str) -> Result<models::GetTableResult, Error<GetTableError>> {
+pub async fn get_table(configuration: &configuration::Configuration, ns: &str, table: &str) -> Result<models::GetTableResponse, Error<GetTableError>> {
     // add a prefix to parameters to efficiently prevent name collisions
     let p_ns = ns;
     let p_table = table;
@@ -220,8 +220,8 @@ pub async fn get_table(configuration: &configuration::Configuration, ns: &str, t
         let content = resp.text().await?;
         match content_type {
             ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
-            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetTableResult`"))),
-            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetTableResult`")))),
+            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetTableResponse`"))),
+            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetTableResponse`")))),
         }
     } else {
         let content = resp.text().await?;
diff --git a/rust/lance-catalog-reqwest-client/src/models/get_table_response.rs b/rust/lance-catalog-reqwest-client/src/models/get_table_response.rs
@@ -11,17 +11,17 @@
 use crate::models;
 use serde::{Deserialize, Serialize};
 
-/// GetTableResult : Result used when a table is successfully loaded. 
+/// GetTableResponse : Result used when a table is successfully loaded. 
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
-pub struct GetTableResult {
+pub struct GetTableResponse {
     #[serde(rename = "properties", skip_serializing_if = "Option::is_none")]
     pub properties: Option<std::collections::HashMap<String, String>>,
 }
 
-impl GetTableResult {
+impl GetTableResponse {
     /// Result used when a table is successfully loaded. 
-    pub fn new() -> GetTableResult {
-        GetTableResult {
+    pub fn new() -> GetTableResponse {
+        GetTableResponse {
             properties: None,
         }
     }
diff --git a/rust/lance-catalog-reqwest-client/src/models/mod.rs b/rust/lance-catalog-reqwest-client/src/models/mod.rs
@@ -6,7 +6,7 @@ pub mod error_model;
 pub use self::error_model::ErrorModel;
 pub mod get_namespace_response;
 pub use self::get_namespace_response::GetNamespaceResponse;
-pub mod get_table_result;
-pub use self::get_table_result::GetTableResult;
+pub mod get_table_response;
+pub use self::get_table_response::GetTableResponse;
 pub mod list_namespaces_response;
 pub use self::list_namespaces_response::ListNamespacesResponse;
diff --git a/spec/catalog.yaml b/spec/catalog.yaml
@@ -305,7 +305,7 @@ components:
           default: { }
           nullable: true
 
-    GetTableResult:
+    GetTableResponse:
       description: |
         Result used when a table is successfully loaded.
       type: object
@@ -359,7 +359,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/GetTableResult'
+            $ref: '#/components/schemas/GetTableResponse'
 
     BadRequestErrorResponse:
       description:

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`
`2`	`2`
`3`		`-# GetTableResult`
	`3`	`+# GetTableResponse`
`4`	`4`
`5`	`5`	`Result used when a table is successfully loaded.`
`6`	`6`