Skip to content

refactor(filesystem): remove ListFiles RPC and update file messages f… #83

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
digitalkin-dev merged 1 commit into from
Jun 4, 2025
Merged

refactor(filesystem): remove ListFiles RPC and update file messages f… #83

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
41 changes: 13 additions & 28 deletions proto/digitalkin/filesystem/v1/filesystem.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ message File {

// status: Current status of the file
FileStatus status = 12 [(buf.validate.field).required = true, (buf.validate.field).enum.not_in = 0];

// content: The content of the file
bytes content = 13;
}

// FileFilter: Filter criteria for querying files
Expand Down Expand Up @@ -169,9 +172,12 @@ message UploadFileData {

// metadata: Additional metadata for the file
google.protobuf.Struct metadata = 6;

// status: Status of the file
FileStatus status = 7 [(buf.validate.field).required = true, (buf.validate.field).enum.not_in = 0];

// replace_if_exists: Whether to replace existing file with same name
bool replace_if_exists = 7;
bool replace_if_exists = 8;
}

// UploadFilesRequest: Request to upload multiple files
Expand All @@ -192,30 +198,6 @@ message UploadFilesResponse {
int32 total_failed = 3;
}

// ListFilesRequest: Request to list files with filtering and pagination
message ListFilesRequest {
// filter: Filter criteria for the files
FileFilter filter = 1 [(buf.validate.field).required = true];

// list_size: Number of files to return per page
int32 list_size = 2 [(buf.validate.field).int32.gte = 1, (buf.validate.field).int32.lte = 1000];

// offset: Offset of the first file in the list
int32 offset = 3 [(buf.validate.field).int32.gte = 0];

// order: Field to order results by
string order = 4;
}

// ListFilesResponse: Response for listing files
message ListFilesResponse {
// files: List of files matching the criteria
repeated File files = 1 ;

// total_count: Total number of files matching the filter (optional)
int32 total_count = 2 [(buf.validate.field).int32.gte = 0];
}

// GetFileRequest: Request to get a specific file
message GetFileRequest {
// context: Context ID for the file
Expand All @@ -235,7 +217,7 @@ message GetFileRequest {
// GetFileResponse: Response containing file information
message GetFileResponse {
// file: The requested file
File file = 1;
File file = 1 [(buf.validate.field).required = true];

// content: File content (only if requested)
bytes content = 2;
Expand All @@ -260,9 +242,12 @@ message UpdateFileRequest {

// content: New file content (optional)
bytes content = 6;

// status: New status of the file
FileStatus status = 7 [(buf.validate.field).required = true, (buf.validate.field).enum.not_in = 0];

// metadata: New metadata (optional, will merge with existing)
google.protobuf.Struct metadata = 7;
google.protobuf.Struct metadata = 8;
}

// UpdateFileResponse: Response for file update
Expand Down Expand Up @@ -307,7 +292,7 @@ message GetFilesRequest {
// GetFilesResponse: Response containing multiple files
message GetFilesResponse {
// files: List of files matching the criteria
repeated File files = 1;
repeated File files = 1 [(buf.validate.field).required = true, (buf.validate.field).repeated.min_items = 1];

// total_count: Total number of files matching the criteria
int32 total_count = 2;
Expand Down
10 changes: 0 additions & 10 deletions proto/digitalkin/filesystem/v1/filesystem_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,6 @@ service FilesystemService {
//
rpc UploadFiles(UploadFilesRequest) returns (UploadFilesResponse);

// ListFiles: Retrieve files with filtering, sorting, and pagination
//
// This method provides flexible file querying capabilities with support for:
// - Multiple filter criteria (name, type, dates, size, etc.)
// - Pagination for large result sets
// - Sorting by various fields
// - Scoped access by kin_context
//
rpc ListFiles(ListFilesRequest) returns (ListFilesResponse);

// GetFile: Retrieve a specific file by ID or name
//
// This method fetches detailed information about a single file,
Expand Down