service.proto

syntax = "proto3";

package lensv2;

service LensV2 {
  rpc Index(IndexReq)   returns (IndexResp)  {}
  rpc Search(SearchReq) returns (SearchResp) {}
  rpc Remove(RemoveReq) returns (RemoveResp) {}
}

// INDEX

message IndexReq {
  enum Type {
    UNKNOWN = 0;
    IPLD    = 1;
  }
  Type type = 1;

  string hash          = 2;
  string display_name  = 3;
  repeated string tags = 4;

  message Options {
    bool reindex = 1;
  }
  Options options = 5;
}

message IndexResp {
  Document doc = 1;
}

// SEARCH

message SearchReq {
  string query = 1;
  message Options {
    repeated string required   = 1;
    repeated string tags       = 2;
    repeated string categories = 3;
    repeated string mime_types = 4;
    repeated string hashes     = 5;
  }
  Options options = 2;
}

message SearchResp {
  message Result {
    float score  = 1;
    Document doc = 2;
  }
  repeated Result results = 1;
}

message Document {
  string hash          = 1;
  string display_name  = 2;
  string mime_type     = 3;
  string category      = 4;
  repeated string tags = 5;
}

// REMOVE

message RemoveReq {
  string hash = 1;
}

message RemoveResp {}