Skip to content

fix: add missing 404 responses to spec #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jackye1995 merged 1 commit into from
Jul 20, 2025
Merged

fix: add missing 404 responses to spec #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/src/spec/rest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
403:
$ref: '#/components/responses/ForbiddenErrorResponse'
404:
$ref: '#/components/responses/NotFoundErrorResponse'
406:
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
409:
Expand Down Expand Up @@ -122,6 +124,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
403:
$ref: '#/components/responses/ForbiddenErrorResponse'
404:
$ref: '#/components/responses/NotFoundErrorResponse'
406:
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
503:
Expand Down Expand Up @@ -618,6 +622,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
403:
$ref: '#/components/responses/ForbiddenErrorResponse'
404:
$ref: '#/components/responses/NotFoundErrorResponse'
406:
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
409:
Expand Down Expand Up @@ -652,6 +658,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
403:
$ref: '#/components/responses/ForbiddenErrorResponse'
404:
$ref: '#/components/responses/NotFoundErrorResponse'
406:
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
503:
Expand Down
8 changes: 8 additions & 0 deletions java/lance-namespace-apache-client/api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
"403":
$ref: '#/components/responses/ForbiddenErrorResponse'
"404":
$ref: '#/components/responses/NotFoundErrorResponse'
"406":
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
"409":
Expand Down Expand Up @@ -105,6 +107,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
"403":
$ref: '#/components/responses/ForbiddenErrorResponse'
"404":
$ref: '#/components/responses/NotFoundErrorResponse'
"406":
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
"503":
Expand Down Expand Up @@ -716,6 +720,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
"403":
$ref: '#/components/responses/ForbiddenErrorResponse'
"404":
$ref: '#/components/responses/NotFoundErrorResponse'
"406":
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
"409":
Expand Down Expand Up @@ -756,6 +762,8 @@ paths:
$ref: '#/components/responses/UnauthorizedErrorResponse'
"403":
$ref: '#/components/responses/ForbiddenErrorResponse'
"404":
$ref: '#/components/responses/NotFoundErrorResponse'
"406":
$ref: '#/components/responses/UnsupportedOperationErrorResponse'
"503":
Expand Down
2 changes: 2 additions & 0 deletions java/lance-namespace-apache-client/docs/NamespaceApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ No authorization required
| **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. | - |
| **406** | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
| **409** | The request conflicts with the current state of the target 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. | - |
Expand Down Expand Up @@ -313,6 +314,7 @@ No authorization required
| **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. | - |
| **406** | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
| **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. | - |
| **5XX** | 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. | - |
Expand Down
2 changes: 2 additions & 0 deletions java/lance-namespace-apache-client/docs/TableApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -998,6 +998,7 @@ No authorization required
| **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. | - |
| **406** | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
| **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. | - |
| **5XX** | 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. | - |
Expand Down Expand Up @@ -1228,6 +1229,7 @@ No authorization required
| **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. | - |
| **406** | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
| **409** | The request conflicts with the current state of the target 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. | - |
Expand Down
46 changes: 38 additions & 8 deletions ...-server/src/main/java/com/lancedb/lance/namespace/server/springboot/api/NamespaceApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,14 @@ default Optional<NativeWebRequest> getRequest() {
* cases simple text/plain content might be returned by the server&#39;s 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 Not Acceptable / Unsupported Operation. The server does
* not support this operation. (status code 406) or The request conflicts with the current
* state of the target resource. (status code 409) 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)
* permissions. (status code 403) or A server-side problem that means can not find the
* specified resource. (status code 404) or Not Acceptable / Unsupported Operation. The server
* does not support this operation. (status code 406) or The request conflicts with the
* current state of the target resource. (status code 409) 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 = "createNamespace",
Expand Down Expand Up @@ -127,6 +128,14 @@ default Optional<NativeWebRequest> getRequest() {
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "404",
description = "A server-side problem that means can not find the specified resource.",
content = {
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "406",
description =
Expand Down Expand Up @@ -241,6 +250,12 @@ default ResponseEntity<CreateNamespaceResponse> createNamespace(
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;
}
}
});
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
Expand Down Expand Up @@ -618,7 +633,8 @@ default ResponseEntity<DropNamespaceResponse> dropNamespace(
* simple text/plain content might be returned by the server&#39;s 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 Not Acceptable / Unsupported Operation. The server does not support
* (status code 403) or A server-side problem that means can not find the specified resource.
* (status code 404) or Not Acceptable / Unsupported Operation. The server does not support
* this operation. (status code 406) 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
Expand Down Expand Up @@ -666,6 +682,14 @@ default ResponseEntity<DropNamespaceResponse> dropNamespace(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "404",
description = "A server-side problem that means can not find the specified resource.",
content = {
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "406",
description =
Expand Down Expand Up @@ -766,6 +790,12 @@ default ResponseEntity<ListNamespacesResponse> listNamespaces(
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;
}
}
});
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
Expand Down
34 changes: 32 additions & 2 deletions ...boot-server/src/main/java/com/lancedb/lance/namespace/server/springboot/api/TableApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2071,7 +2071,8 @@ default ResponseEntity<IndexListResponse> listIndices(
* text/plain content might be returned by the server&#39;s 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 Not Acceptable / Unsupported Operation. The server does not support this
* code 403) or A server-side problem that means can not find the specified resource. (status
* code 404) or Not Acceptable / Unsupported Operation. The server does not support this
* operation. (status code 406) 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
Expand Down Expand Up @@ -2119,6 +2120,14 @@ default ResponseEntity<IndexListResponse> listIndices(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "404",
description = "A server-side problem that means can not find the specified resource.",
content = {
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "406",
description =
Expand Down Expand Up @@ -2217,6 +2226,12 @@ default ResponseEntity<ListTablesResponse> listTables(
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;
}
}
});
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
Expand Down Expand Up @@ -2608,7 +2623,8 @@ default ResponseEntity<org.springframework.core.io.Resource> queryTable(
* although in some cases simple text/plain content might be returned by the server&#39;s
* 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 Not Acceptable / Unsupported
* have the necessary permissions. (status code 403) or A server-side problem that means can
* not find the specified resource. (status code 404) or Not Acceptable / Unsupported
* Operation. The server does not support this operation. (status code 406) or The request
* conflicts with the current state of the target resource. (status code 409) or The service
* is not ready to handle the request. The client should wait and retry. The service may
Expand Down Expand Up @@ -2656,6 +2672,14 @@ default ResponseEntity<org.springframework.core.io.Resource> queryTable(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "404",
description = "A server-side problem that means can not find the specified resource.",
content = {
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))
}),
@ApiResponse(
responseCode = "406",
description =
Expand Down Expand Up @@ -2770,6 +2794,12 @@ default ResponseEntity<RegisterTableResponse> registerTable(
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;
}
}
});
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
Expand Down
2 changes: 2 additions & 0 deletions python/lance_namespace_urllib3_client/docs/NamespaceApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ No authorization required
**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&#39;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. | - |
**406** | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
**409** | The request conflicts with the current state of the target 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. | - |
Expand Down Expand Up @@ -332,6 +333,7 @@ No authorization required
**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&#39;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. | - |
**406** | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
**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. | - |
**5XX** | 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. | - |
Expand Down
Loading