olai-codegen 0.0.14

Proto-driven code generation for REST handlers, clients, and resource registries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

syntax = "proto3";
package example.edge.v1;

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";

// Edge cases the main `example.bin` fixture doesn't reach. Compiled into the committed
// `example_edge_cases.bin` (see `tests/generation_integration.rs` for the protoc command).

// A resource whose name component is a Rust keyword (`type`): the extractors, accessors and
// `qualified_name()` must emit it as `r#type`.
message Kind {
  option (google.api.resource) = {
    type: "example.io/Kind"
    pattern: "kinds/{type}"
    plural: "kinds"
    singular: "kind"
    name_field: "type"
  };

  string type = 1;
  string comment = 2 [(google.api.field_behavior) = OPTIONAL];
  string kind_id = 3 [(google.api.field_behavior) = IDENTIFIER];
}

service KindService {
  rpc ListKinds(ListKindsRequest) returns (ListKindsResponse) {
    option (google.api.http) = {get: "/kinds"};
  }
  rpc GetKind(GetKindRequest) returns (Kind) {
    option (google.api.http) = {get: "/kinds/{type}"};
  }
  rpc DeleteKind(DeleteKindRequest) returns (DeleteKindResponse) {
    option (google.api.http) = {delete: "/kinds/{type}"};
  }
  // A resource-targeted existence check: the native scoped client returns its `bool`.
  rpc CheckKind(CheckKindRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      custom: {kind: "HEAD", path: "/kinds/{type}"}
    };
  }
}

message ListKindsRequest {
  // A keyword-named optional query param.
  optional string match = 1;
  int32 max_results = 2;
  string page_token = 3;
}

message ListKindsResponse {
  repeated Kind kinds = 1;
  string next_page_token = 2;
}

message GetKindRequest {
  string type = 1;
}

message DeleteKindRequest {
  string type = 1;
}

message DeleteKindResponse {}

message CheckKindRequest {
  string type = 1;
}

// A resource-less service with keyword path params and a message with two oneofs.
service RouteService {
  rpc PutRoute(PutRouteRequest) returns (Route) {
    option (google.api.http) = {
      post: "/routes/{type}/{ref}"
      body: "route"
    };
  }
  rpc ListRoutes(ListRoutesRequest) returns (ListRoutesResponse) {
    option (google.api.http) = {get: "/routes"};
  }
}

message ListRoutesRequest {
  // A keyword-named required query param.
  string ref = 1 [(google.api.field_behavior) = REQUIRED];
}

message ListRoutesResponse {
  repeated Route routes = 1;
}

message PutRouteRequest {
  string type = 1;
  string ref = 2;
  Route route = 3 [(google.api.field_behavior) = REQUIRED];
}

// Two oneofs, declared out of alphabetical order: the parsed fields must keep declaration order
// (`target`, then `source`), not hash order.
message Route {
  oneof target {
    string target_url = 1;
    int64 target_id = 2;
  }
  oneof source {
    string source_url = 3;
    int64 source_id = 4;
  }
  string note = 5;
}