Ccosproc/proto/device/v3/device.proto

// define syntax used in proto file
syntax = "proto3";
// options used by gRPC golang plugin(not related to gRPC gateway)
//option go_package = "github.com/osguydch/ccosproc";

package Device.V3;

// well know type by google, gRPC gateway uses HTTP annotation.
import "google/api/annotations.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
//import "third_party/googleapis/google/api/annotations.proto";

// These annotations are used when generating the OpenAPI file.
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
  info: {version: "3.0"};
  external_docs: {
    url: "https://github.com/osguydch/ccosproc";
    description: "gRPC-gateway boilerplate repository";
  }
  schemes: HTTPS;
};

// simple message
message OpenRequest {
  string deviceUri = 1;
  string deviceGroup = 2;
}

message OpenReply {
  string message = 1;
  string retCode = 2;
  string retContext = 3;
}

message DoRequest{
  string deviceUri = 1;
  string reqName = 2;
  string reqParam = 3;
  string reqTransaction = 4;
  string reqClientID = 5;
}

message DoResponse{
  string deviceUri = 1;
  string retCode = 2;
  string reqName = 3;
  string respResult = 4;
  string reqTransaction = 5;
  string retContext = 6;
}

// a gRPC service
service Device {
 // Open is a rpc call and a option is defined for it
  rpc Open (OpenRequest) returns (OpenReply) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Open" call this rpc method over this service
      post: "/api/v1/Device/Open"
      body: "*"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Open a Deivce"
      description: "Open Device from Platform."
      tags: "Device"
    };
  };
  rpc Close (OpenRequest) returns (OpenReply) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      post: "/api/v1/Device/Close"
      body: "*"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Close Opened Deivce"
      description: "Close Device from Platform."
      tags: "Device"
    };
  };
  rpc Get (DoRequest) returns (DoResponse) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      get: "/api/v1/Device/Get/{reqName}"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Get Properties Value from Deivce"
      description: "Get Properties Value from Deivce Platform."
      tags: "Device"
    };
  };

  rpc Set (DoRequest) returns (DoResponse) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      put: "/api/v1/Device/Set/{reqName}"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Set Properties Value from Deivce"
      description: "Set Properties Value from Deivce Platform."
      tags: "Device"
    };
  };

  rpc Update (DoRequest) returns (DoResponse) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      post: "/api/v1/Device/Update/{reqName}"
      body: "*"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Update Properties Value for Deivce, effort immediately"
      description: "Update Properties Value for Deivce at Platform."
      tags: "Device"
    };
  };

  rpc Add (DoRequest) returns (DoResponse) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      post: "/api/v1/Device/Add/{reqName}"
      body: "*"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Add Properties Value for Deivce"
      description: "Add Properties Value for Deivce at Platform if Property canbe added."
      tags: "Device"
    };
  };
  rpc Del (DoRequest) returns (DoResponse) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      delete: "/api/v1/Device/Del/{reqName}"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Delete Properties Value for Deivce"
      description: "Delete Properties Value for Deivce at Platform if Property canbe deleted."
      tags: "Device"
    };
  };
  rpc Action (DoRequest) returns (DoResponse) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      post: "/api/v1/Device/Action/{reqName}"
      body: "*"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Execuate Action for Deivce"
      description: "Execuate Action for Deivce at Platform ."
      tags: "Device"
    };
  };
  rpc Message (DoRequest) returns (DoResponse) {
  // option type is http
    option (google.api.http) = {
    // this is url, for RESTfull/JSON api and method
    // this line means when a HTTP post request comes with "/v1/Device/Close" call this rpc method over this service
      post: "/api/v1/Device/Message"
      body: "*"
    };
    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
      summary: "Send Message to Deivce"
      description: "Send Message to Deivce at Platform "
      tags: "Device"
    };
  };
}