Skip to content

Commit

Permalink
proposed proto changes for metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
stevebriskin committed Oct 20, 2023
1 parent 8fc476f commit 37f5f7f
Showing 1 changed file with 84 additions and 0 deletions.
84 changes: 84 additions & 0 deletions proto/viam/app/v1/app.proto
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ service AppService {
// Delete an organization
rpc DeleteOrganization(DeleteOrganizationRequest) returns (DeleteOrganizationResponse);

// Get user-defined metadata for an organization
rpc GetOrganizationMetadata(GetOrganizationMetadataRequest) returns (GetOrganizationMetadataResponse);

// Update user-defined metadata for an organization
rpc UpdateOrganizationMetadata(UpdateOrganizationMetadataRequest) returns (UpdateOrganizationMetadataResponse);

// List all members of an organization and all invited members to the organization.
rpc ListOrganizationMembers(ListOrganizationMembersRequest) returns (ListOrganizationMembersResponse);

Expand Down Expand Up @@ -69,6 +75,12 @@ service AppService {
// Delete a location
rpc DeleteLocation(DeleteLocationRequest) returns (DeleteLocationResponse);

// Get user-defined metadata for a location
rpc GetLocationMetadata(GetLocationMetadataRequest) returns (GetLocationMetadataResponse);

// Update user-defined metadata for a location
rpc UpdateLocationMetadata(UpdateLocationMetadataRequest) returns (UpdateLocationMetadataResponse);

// Get a list of locations
rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse);

Expand All @@ -91,6 +103,12 @@ service AppService {
// Get a specific robot by ID
rpc GetRobot(GetRobotRequest) returns (GetRobotResponse);

// Get user-defined metadata for a robot
rpc GetRobotMetadata(GetRobotMetadataRequest) returns (GetRobotMetadataResponse);

// Update user-defined metadata for an robot
rpc UpdateRobotMetadata(UpdateRobotMetadataRequest) returns (UpdateRobotMetadataResponse);

// Get Rover Rental Location Robots
rpc GetRoverRentalRobots(GetRoverRentalRobotsRequest) returns (GetRoverRentalRobotsResponse);

Expand All @@ -115,6 +133,12 @@ service AppService {
// Delete a robot part
rpc DeleteRobotPart(DeleteRobotPartRequest) returns (DeleteRobotPartResponse);

// Get user-defined metadata for a robot part
rpc GetRobotPartMetadata(GetRobotPartMetadataRequest) returns (GetRobotPartMetadataResponse);

// Update user-defined metadata for an robot part
rpc UpdateRobotPartMetadata(UpdateRobotPartMetadataRequest) returns (UpdateRobotPartMetadataResponse);

// Gets the Robot API Keys for the robot
rpc GetRobotAPIKeys(GetRobotAPIKeysRequest) returns (GetRobotAPIKeysResponse);

Expand Down Expand Up @@ -311,6 +335,21 @@ message DeleteOrganizationRequest {

message DeleteOrganizationResponse {}

message GetOrganizationMetadataRequest {
string organization_id = 1;
}

message GetOrganizationMetadataResponse {
bytes data = 1;
}

message UpdateOrganizationMetadataRequest {
string organization_id = 1;
bytes data = 2;
}

message UpdateOrganizationMetadataResponse {}

message ListOrganizationMembersRequest {
string organization_id = 1;
}
Expand Down Expand Up @@ -480,6 +519,21 @@ message DeleteLocationRequest {

message DeleteLocationResponse {}

message GetLocationMetadataRequest {
string location_id = 1;
}

message GetLocationMetadataResponse {
bytes data = 1;
}

message UpdateLocationMetadataRequest {
string location_id = 1;
bytes data = 2;
}

message UpdateLocationMetadataResponse {}

message ListLocationsRequest {
// Organization ID under which to list all locations.
string organization_id = 1;
Expand Down Expand Up @@ -635,6 +689,21 @@ message DeleteRobotPartRequest {
string part_id = 1;
}

message GetRobotPartMetadataRequest {
string id = 1;
}

message GetRobotPartMetadataResponse {
bytes data = 1;
}

message UpdateRobotPartMetadataRequest {
string id = 1;
bytes data = 2;
}

message UpdateRobotPartMetadataResponse {}

message GetRobotAPIKeysRequest {
string robot_id = 1;
}
Expand Down Expand Up @@ -745,6 +814,21 @@ message DeleteRobotRequest {

message DeleteRobotResponse {}

message GetRobotMetadataRequest {
string id = 1;
}

message GetRobotMetadataResponse {
bytes data = 1;
}

message UpdateRobotMetadataRequest {
string id = 1;
bytes data = 2;
}

message UpdateRobotMetadataResponse {}

message MarkPartAsMainRequest {
string part_id = 1;
}
Expand Down

0 comments on commit 37f5f7f

Please sign in to comment.