github.com/bhojpur/cache@v0.0.4/pkg/api/v1/cache-ui.proto (about)

     1  syntax = "proto3";
     2  
     3  package v1;
     4  option go_package = "github.com/bhojpur/cache/pkg/api/v1";
     5  import "cache.proto";
     6  
     7  message ListEngineSpecsRequest{}
     8  
     9  message ListEngineSpecsResponse {
    10      Repository repo = 1;
    11      string name = 2;
    12      string path = 3;
    13      string description = 4;
    14      repeated DesiredAnnotation arguments = 5;
    15  }
    16  
    17  // DesiredAnnotation describes an annotation a Engine should have
    18  message DesiredAnnotation {
    19      string name = 1;
    20      bool required = 2;
    21      string description = 3;
    22  }
    23  
    24  message IsReadOnlyRequest {}
    25  
    26  message IsReadOnlyResponse {
    27      bool readonly = 1;
    28  }
    29  
    30  // CacheUI offers services intended for the Bhojpur Cache web user interface
    31  service CacheUI {
    32      // ListEngineSpecs returns a list of Cache Engine(s) that can be started through the UI.
    33      rpc ListEngineSpecs(ListEngineSpecsRequest) returns (stream ListEngineSpecsResponse) {};
    34  
    35      // IsReadOnly returns true if the UI is readonly.
    36      rpc IsReadOnly(IsReadOnlyRequest) returns (IsReadOnlyResponse) {};
    37  }