[monorail go api] add IssuesList rpc

go/src/infra/monorail/monorail.proto

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file *partially* describes Monorail API.
 // It is derived from
 // https://chromium.googlesource.com/infra/infra/+/f2e2a4d/appengine/monorail/services/api_svc_v1.py
 // and
 // https://chromium.googlesource.com/infra/infra/+/f2e2a4d/appengine/monorail/proto/api_pb2_v1.py
 
 syntax = "proto3";
 
 package monorail;
 
 // Monorail service can manipulate issues.
 service Monorail {
     // Creates an issue.
     rpc InsertIssue(InsertIssueRequest) returns (InsertIssueResponse){};
     // Posts a comment to an issue. Can update issue attributes, such as status.
     rpc InsertComment(InsertCommentRequest) returns (InsertCommentResponse){};
+    // Lists issues from a project.
+    rpc IssuesList(IssuesListRequest) returns (IssuesListResponse){};
 }
 
 // A monorail issue.
 message Issue {
     // Reporter of the issue.
     AtomPerson author = 1;
     // Issues that must be fixed before this one can be fixed.
     repeated IssueRef blockedOn = 2;
     // People participating in the issue discussion.
     repeated AtomPerson cc = 6;
@@ skipping 62 matching lines @@
         Update updates = 8;
     }
     // Definition of the comment.
     Comment comment = 1;
     // The reference to post the comment to.
     IssueRef issue = 2;
 }
 
 message InsertCommentResponse{}
 
+// Request for a list of Monorail.Issue()

[nodir, 2016/06/09 15:55:55]

Why "()"?

[seanmccullough1, 2016/06/09 16:11:40]

Why the  () on every other Request message comment in this file?

Removed.

[nodir, 2016/06/09 16:20:16]

because those are RPCs, e.g. Monorail is a service name and InsertComment is an
RPC. There is no "Issue" RPC in Monorail service

To be consistent, it should be "Request for Monorail.IssuesList()"
I don't see it removed

[seanmccullough1, 2016/06/09 16:26:27]

oops sorry. Done.

+message IssuesListRequest {
+  // String name of the project, e.g. "chromium".
+  string projectId = 1;
+  // Additional projects to search.
+  repeated string additionalProject = 2;
+  enum CannedQuery {
+    ALL = 0;
+    NEW = 1;
+    OPEN = 2;
+    OWNED = 3;
+    REPORTED = 4;
+    STARRED = 5;
+    TO_VERIFY = 6;
+  }
+  // Use a canned query.
+  CannedQuery can = 3;
+  // Issue label.
+  string label = 4;

[nodir, 2016/06/09 15:55:55]

this field should have been repeated
I've filed https://bugs.chromium.org/p/monorail/issues/detail?id=1440
if you and/or sheyang agrees that it is a bug that needs to be fixed, please
make this field repeated. It will work for 0 and 1 labels, but we won't work for
more until monorail api is fixed

[seanmccullough1, 2016/06/09 16:11:41]

see comment on bug

[nodir, 2016/06/09 16:20:16]

then document that this is a space-separated list of labels

same below

[seanmccullough1, 2016/06/09 16:26:27]

Done.

+  // Maximum results to retrieve.
+  int32 maxResults = 5;
+  // Issue owner.
+  string owner = 6;
+  // Search for Issues published before this timestamp.
+  int64 publishedMax = 7;
+  // Search for Issues published after this timestamp.
+  int64 publishedMin = 8;
+  // Free-form text query.
+  string q = 9;
+  // Sort-by field.
+  string sort = 10;

[nodir, 2016/06/09 15:55:55]

same here

[seanmccullough1, 2016/06/09 16:11:41]

The point of this CL is to make it possible to use the existing API from go, not
to fix the API semantics. That conversation should happen separately and
independently.

[nodir, 2016/06/09 16:20:15]

ack

+  // Starting index for pagination.
+  int32 startIndex = 11;
+  // Issue status.
+  string status = 12;
+  // Search for Issues most recently updated before this timestamp.
+  int64 updatedMax = 13;
+  // Search for Issues most recently updated after this timestamp.
+  int64 updatedMin = 14;
+}
+
+message ErrorMessage {
+  int32 code = 1;
+  string reason = 2;
+  string message = 3;
+}
+
+message IssuesListResponse {
+  ErrorMessage error = 1;
+  // Search results.
+  repeated Issue items = 2;
+  // Total size of matching result set, regardless of how many are included
+  // in this response.
+  int32 totalResults = 3;
+  // Should always be "monorail#issueList"
+  string kind = 4;

[nodir, 2016/06/09 15:55:55]

kind is endpoints-specific (included in all responses), while this .proto is
more general. Please remove this field

[seanmccullough1, 2016/06/09 16:11:41]

Done.

+}
+
 // Defines a mutation to an issue.
 // This message is partial.
 // Derived from Update type in api_pb2_v1.py.
 message Update {
     // If set, the new status of the issue.
     string status = 2;
 }
 
 // Identifies a Monorail user.
 message AtomPerson {
     // User email.
     string name = 1;
 }