Merge pull request #77 from o7studios/76-refactor-get-route

Refactore Get Route

Author: raphael-goetz

proto/v1/api.proto

@@ -16,6 +16,10 @@ service Octopus {
    * key pattern. Can optionally include expired (include all
    * revisions) objects and filter by creation time.
    */
+  rpc Query(QueryRequest) returns (QueryResponse);
+  /**
+   * Retrieves only one existing entry from the database matching a key.
+   */
   rpc Get(GetRequest) returns (GetResponse);
   /**
    * Stores an object on key.
@@ -86,9 +90,9 @@ message Entry {
 }
 
 /**
- * Filters and options for `Get` RPC.
+ * Filters and options for `Query` RPC.
  */
-message GetRequest {
+message QueryRequest {
   // Pattern to match keys. Supports wildcards:
   //   *  — matches exactly one token (between dots), e.g., "foo.*.bar" matches "foo.x.bar" but not "foo.x.y.bar"
   //   >  — matches one or more tokens until the end, e.g., "foo.>" matches "foo", "foo.bar", "foo.bar.baz", etc.
@@ -111,6 +115,23 @@ message GetRequest {
   Paginator paginator = 6;
 }
 
+/**
+ * For getting an exact value to a key you already have
+ */
+message GetRequest {
+  // Exact key to a object
+  string key = 1;
+}
+
+message GetResponse {
+  oneof result {
+    // If the key points only to one value it will be returned
+    Object object = 1;
+    // If no object is found for the given key, this field is set
+    google.protobuf.Empty empty = 2;
+  }
+}
+
 /**
  * Paginator for database entry cursor-pagination.
  */
@@ -134,9 +155,9 @@ message PageInfo {
 }
 
 /**
- * Result of `Get` RPC.
+ * Result of `Query` RPC.
  */
-message GetResponse {
+message QueryResponse {
   // List of found entries including revision, ID and timestamps.
   repeated Entry entries = 1;