From 5d7947362d629d20ba6e4f765fb622a07c5c3884 Mon Sep 17 00:00:00 2001
From: Asim Aslam <asim@aslam.me>
Date: Sat, 22 May 2021 16:53:46 +0100
Subject: [PATCH] add proto commnets

---
 location/proto/location.proto | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/location/proto/location.proto b/location/proto/location.proto
index 7ea5cc0..58357e9 100644
--- a/location/proto/location.proto
+++ b/location/proto/location.proto
@@ -27,7 +27,9 @@ message Entity {
         Point location = 3;
 }
 
+// Read an entity by its ID
 message ReadRequest {
+	// the entity id
 	string id = 1;
 }
 
@@ -35,6 +37,7 @@ message ReadResponse {
 	Entity entity = 1;
 }
 
+// Save an entity's current position
 message SaveRequest {
 	Entity entity = 1;
 }
@@ -42,11 +45,15 @@ message SaveRequest {
 message SaveResponse {
 }
 
+// Search for entities in a given radius
 message SearchRequest {
+	// Central position to search from
 	Point center = 1;
-	// in meters
+	// radius in meters
 	double radius = 2;
+	// type of entities to filter
 	string type = 3;
+	// number of entities to return
 	int64 numEntities = 4;
 }