spec: get table under ns

Author: yanghua

java/lance-catalog-apache-client/api/openapi.yaml

@@ -184,6 +184,8 @@ paths:
           $ref: '#/components/responses/GetTableResponse'
         "400":
           $ref: '#/components/responses/BadRequestErrorResponse'
+        "401":
+          $ref: '#/components/responses/UnauthorizedResponse'
         "403":
           $ref: '#/components/responses/ForbiddenResponse'
         "404":
@@ -477,15 +479,19 @@ components:
       description: |
         Result used when a table is successfully loaded.
       example:
+        name: name
         location: location
         properties:
           key: properties
       properties:
+        name:
+          type: string
         location:
           type: string
         properties:
           additionalProperties:
             type: string
       required:
       - location
+      - name
 

java/lance-catalog-apache-client/docs/GetTableResponse.md

@@ -8,6 +8,7 @@ Result used when a table is successfully loaded.
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
+|**name** | **String** |  |  |
 |**location** | **String** |  |  |
 |**properties** | **Map<String, String>** |  |  [optional] |
 

java/lance-catalog-apache-client/docs/NamespaceApi.md

@@ -291,6 +291,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | Table properties result when loading a table |  -  |
 | **400** | Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware. |  -  |
+| **401** | Unauthorized. The request lacks valid authentication credentials for the operation. |  -  |
 | **403** | Forbidden. Authenticated user does not have the necessary permissions. |  -  |
 | **404** | A server-side problem that means can not find the specified resource. |  -  |
 | **503** | The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry. |  -  |

java/lance-catalog-apache-client/src/main/java/com/lancedb/lance/catalog/client/apache/model/GetTableResponse.java

@@ -26,13 +26,17 @@
 
 /** Result used when a table is successfully loaded. */
 @JsonPropertyOrder({
+  GetTableResponse.JSON_PROPERTY_NAME,
   GetTableResponse.JSON_PROPERTY_LOCATION,
   GetTableResponse.JSON_PROPERTY_PROPERTIES
 })
 @javax.annotation.Generated(
     value = "org.openapitools.codegen.languages.JavaClientCodegen",
     comments = "Generator version: 7.12.0")
 public class GetTableResponse {
+  public static final String JSON_PROPERTY_NAME = "name";
+  @javax.annotation.Nonnull private String name;
+
   public static final String JSON_PROPERTY_LOCATION = "location";
   @javax.annotation.Nonnull private String location;
 
@@ -41,6 +45,30 @@ public class GetTableResponse {
 
   public GetTableResponse() {}
 
+  public GetTableResponse name(@javax.annotation.Nonnull String name) {
+
+    this.name = name;
+    return this;
+  }
+
+  /**
+   * Get name
+   *
+   * @return name
+   */
+  @javax.annotation.Nonnull
+  @JsonProperty(JSON_PROPERTY_NAME)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
+  public String getName() {
+    return name;
+  }
+
+  @JsonProperty(JSON_PROPERTY_NAME)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
+  public void setName(@javax.annotation.Nonnull String name) {
+    this.name = name;
+  }
+
   public GetTableResponse location(@javax.annotation.Nonnull String location) {
 
     this.location = location;
@@ -106,19 +134,21 @@ public boolean equals(Object o) {
       return false;
     }
     GetTableResponse getTableResponse = (GetTableResponse) o;
-    return Objects.equals(this.location, getTableResponse.location)
+    return Objects.equals(this.name, getTableResponse.name)
+        && Objects.equals(this.location, getTableResponse.location)
         && Objects.equals(this.properties, getTableResponse.properties);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(location, properties);
+    return Objects.hash(name, location, properties);
   }
 
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append("class GetTableResponse {\n");
+    sb.append("    name: ").append(toIndentedString(name)).append("\n");
     sb.append("    location: ").append(toIndentedString(location)).append("\n");
     sb.append("    properties: ").append(toIndentedString(properties)).append("\n");
     sb.append("}");
@@ -167,6 +197,21 @@ public String toUrlQueryString(String prefix) {
 
     StringJoiner joiner = new StringJoiner("&");
 
+    // add `name` to the URL query string
+    if (getName() != null) {
+      try {
+        joiner.add(
+            String.format(
+                "%sname%s=%s",
+                prefix,
+                suffix,
+                URLEncoder.encode(String.valueOf(getName()), "UTF-8").replaceAll("\\+", "%20")));
+      } catch (UnsupportedEncodingException e) {
+        // Should never happen, UTF-8 is always supported
+        throw new RuntimeException(e);
+      }
+    }
+
     // add `location` to the URL query string
     if (getLocation() != null) {
       try {

java/lance-catalog-springboot-server/src/main/java/com/lancedb/lance/catalog/server/springboot/api/NamespaceApi.java

@@ -501,13 +501,14 @@ default ResponseEntity<GetNamespaceResponse> getNamespace(
    *     request error. It could be caused by an unexpected request body format or other forms of
    *     request validation failure, such as invalid json. Usually serves application/json content,
    *     although in some cases simple text/plain content might be returned by the server&#39;s
-   *     middleware. (status code 400) or Forbidden. Authenticated user does not have the necessary
-   *     permissions. (status code 403) or A server-side problem that means can not find the
-   *     specified resource. (status code 404) or The service is not ready to handle the request.
-   *     The client should wait and retry. The service may additionally send a Retry-After header to
-   *     indicate when to retry. (status code 503) or A server-side problem that might not be
-   *     addressable from the client side. Used for server 5xx errors without more specific
-   *     documentation in individual routes. (status code 5XX)
+   *     middleware. (status code 400) or Unauthorized. The request lacks valid authentication
+   *     credentials for the operation. (status code 401) or Forbidden. Authenticated user does not
+   *     have the necessary permissions. (status code 403) or A server-side problem that means can
+   *     not find the specified resource. (status code 404) or The service is not ready to handle
+   *     the request. The client should wait and retry. The service may additionally send a
+   *     Retry-After header to indicate when to retry. (status code 503) or A server-side problem
+   *     that might not be addressable from the client side. Used for server 5xx errors without more
+   *     specific documentation in individual routes. (status code 5XX)
    */
   @Operation(
       operationId = "getTable",
@@ -533,6 +534,15 @@ default ResponseEntity<GetNamespaceResponse> getNamespace(
                   mediaType = "application/json",
                   schema = @Schema(implementation = ErrorModel.class))
             }),
+        @ApiResponse(
+            responseCode = "401",
+            description =
+                "Unauthorized. The request lacks valid authentication credentials for the operation.",
+            content = {
+              @Content(
+                  mediaType = "application/json",
+                  schema = @Schema(implementation = ErrorModel.class))
+            }),
         @ApiResponse(
             responseCode = "403",
             description = "Forbidden. Authenticated user does not have the necessary permissions.",
@@ -593,7 +603,13 @@ default ResponseEntity<GetTableResponse> getTable(
               for (MediaType mediaType : MediaType.parseMediaTypes(request.getHeader("Accept"))) {
                 if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
                   String exampleString =
-                      "{ \"location\" : \"location\", \"properties\" : { \"key\" : \"properties\" } }";
+                      "{ \"name\" : \"name\", \"location\" : \"location\", \"properties\" : { \"key\" : \"properties\" } }";
+                  ApiUtil.setExampleResponse(request, "application/json", exampleString);
+                  break;
+                }
+                if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
+                  String exampleString =
+                      "{ \"instance\" : \"/login/log/abc123\", \"detail\" : \"Authentication failed due to incorrect username or password\", \"type\" : \"/errors/incorrect-user-pass\", \"title\" : \"Incorrect username or password\", \"status\" : 404 }";
                   ApiUtil.setExampleResponse(request, "application/json", exampleString);
                   break;
                 }

java/lance-catalog-springboot-server/src/main/java/com/lancedb/lance/catalog/server/springboot/model/GetTableResponse.java

@@ -34,6 +34,8 @@
     comments = "Generator version: 7.12.0")
 public class GetTableResponse {
 
+  private String name;
+
   private String location;
 
   @Valid private Map<String, String> properties = new HashMap<>();
@@ -43,10 +45,32 @@ public GetTableResponse() {
   }
 
   /** Constructor with only required parameters */
-  public GetTableResponse(String location) {
+  public GetTableResponse(String name, String location) {
+    this.name = name;
     this.location = location;
   }
 
+  public GetTableResponse name(String name) {
+    this.name = name;
+    return this;
+  }
+
+  /**
+   * Get name
+   *
+   * @return name
+   */
+  @NotNull
+  @Schema(name = "name", requiredMode = Schema.RequiredMode.REQUIRED)
+  @JsonProperty("name")
+  public String getName() {
+    return name;
+  }
+
+  public void setName(String name) {
+    this.name = name;
+  }
+
   public GetTableResponse location(String location) {
     this.location = location;
     return this;
@@ -105,19 +129,21 @@ public boolean equals(Object o) {
       return false;
     }
     GetTableResponse getTableResponse = (GetTableResponse) o;
-    return Objects.equals(this.location, getTableResponse.location)
+    return Objects.equals(this.name, getTableResponse.name)
+        && Objects.equals(this.location, getTableResponse.location)
         && Objects.equals(this.properties, getTableResponse.properties);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(location, properties);
+    return Objects.hash(name, location, properties);
   }
 
   @Override
   public String toString() {
     StringBuilder sb = new StringBuilder();
     sb.append("class GetTableResponse {\n");
+    sb.append("    name: ").append(toIndentedString(name)).append("\n");
     sb.append("    location: ").append(toIndentedString(location)).append("\n");
     sb.append("    properties: ").append(toIndentedString(properties)).append("\n");
     sb.append("}");

rust/lance-catalog-reqwest-client/docs/GetTableResponse.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
 **location** | **String** |  | 
 **properties** | Option<**std::collections::HashMap<String, String>**> |  | [optional]
 

rust/lance-catalog-reqwest-client/src/apis/namespace_api.rs

@@ -59,6 +59,7 @@ pub enum GetNamespaceError {
 #[serde(untagged)]
 pub enum GetTableError {
     Status400(models::ErrorModel),
+    Status401(models::ErrorModel),
     Status403(models::ErrorModel),
     Status404(models::ErrorModel),
     Status503(models::ErrorModel),

rust/lance-catalog-reqwest-client/src/models/get_table_response.rs

@@ -14,6 +14,8 @@ use serde::{Deserialize, Serialize};
 /// GetTableResponse : Result used when a table is successfully loaded. 
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct GetTableResponse {
+    #[serde(rename = "name")]
+    pub name: String,
     #[serde(rename = "location")]
     pub location: String,
     #[serde(rename = "properties", skip_serializing_if = "Option::is_none")]
@@ -22,8 +24,9 @@ pub struct GetTableResponse {
 
 impl GetTableResponse {
     /// Result used when a table is successfully loaded. 
-    pub fn new(location: String) -> GetTableResponse {
+    pub fn new(name: String, location: String) -> GetTableResponse {
         GetTableResponse {
+            name,
             location,
             properties: None,
         }

spec/catalog.yaml

@@ -189,6 +189,8 @@ paths:
           $ref: '#/components/responses/GetTableResponse'
         400:
           $ref: '#/components/responses/BadRequestErrorResponse'
+        401:
+          $ref: '#/components/responses/UnauthorizedResponse'
         403:
           $ref: '#/components/responses/ForbiddenResponse'
         404:
@@ -310,8 +312,11 @@ components:
         Result used when a table is successfully loaded.
       type: object
       required:
+        - name
         - location
       properties:
+        name:
+          type: string
         location:
           type: string
         properties: