Skip to content

Consolidate camera api demo #679

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.

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

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

nicksanford
Copy link
Member

No description provided.

@github-actions github-actions bot added the safe to test committer is a member of this org label Apr 15, 2025
@nicksanford nicksanford force-pushed the consolidate-camera-api-demo branch from fee1a7a to 22b850a Compare April 30, 2025 22:01
Comment on lines +17 to 41
// returned.
rpc GetImage(GetImageRequest) returns (GetImageResponse) {
option deprecated = true;
option (google.api.http) = {get: "/viam/api/v1/component/camera/{name}/image"};
}

rpc GetImages(GetImagesRequest) returns (GetImagesResponse) {
option deprecated = true;
option (google.api.http) = {get: "/viam/api/v1/component/camera/{name}/images"};
}

// RenderFrame renders a frame from a camera of the underlying robot to an HTTP response. A specific MIME type
// can be requested but may not necessarily be the same one returned.
// RenderFrame renders a frame from a camera of the underlying robot to an
// HTTP response. A specific MIME type can be requested but may not
// necessarily be the same one returned.
rpc RenderFrame(RenderFrameRequest) returns (google.api.HttpBody) {
option deprecated = true;
option (google.api.http) = {get: "/viam/api/v1/component/camera/{name}/render_frame"};
}

// GetPointCloud returns a point cloud from a camera of the underlying robot. A specific MIME type
// can be requested but may not necessarily be the same one returned.
// GetPointCloud returns a point cloud from a camera of the underlying robot.
// A specific MIME type can be requested but may not necessarily be the same
// one returned.
rpc GetPointCloud(GetPointCloudRequest) returns (GetPointCloudResponse) {
option deprecated = true;
option (google.api.http) = {get: "/viam/api/v1/component/camera/{name}/point_cloud"};
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We wouldn't deprecate these APIs immediately as part of this proposal, but rather, we would remove them at the end of the project once all important camera models have been migrated to the new API that can express all of them.

rpc RenderFrame(RenderFrameRequest) returns (google.api.HttpBody) {
option deprecated = true;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering why we needed this custom API endpoint for the frontend to begin with since the web app can handle GRPC responses.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to test committer is a member of this org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants