Update API References in prepare for v0.10.0 release (googleforgames#156)

* Update API References in prepare for v0.10.0 release

* update

* update

* update

Author: yfei1

site/content/en/docs/Guides/Matchmaker/director.md

@@ -91,16 +91,29 @@ rpc AssignTickets(AssignTicketsRequest) returns (AssignTicketsResponse) {
 };
 ```
 
-The API takes a list of TicketIDs to make the Assignment and an Assignment object.
+The API takes a list of `AssignmentGroups` to make the Assignment and returns the AssignmentFailures if any.
 
 #### Assignment
 
-Here is the proto for the Assignment:
+Here are the protos for the Assignment:
 
 ```proto
-message Assignment {
-  string connection = 1;
-  map<string, google.protobuf.Any> extensions = 4;
+message AssignmentGroup{
+  // TicketIds is a list of strings representing Open Match generated Ids which apply to an Assignment.
+  repeated string ticket_ids = 1;
+
+  // An Assignment specifies game connection related information to be associated with the TicketIds.
+  Assignment assignment = 2;
+}
+
+message AssignmentFailure {
+  enum Cause {
+    UNKNOWN = 0;
+    TICKET_NOT_FOUND = 1;
+  }
+
+  string ticket_id = 1;
+  Cause cause = 2;
 }
 ```
 

site/content/en/docs/Guides/Matchmaker/frontend.md

@@ -19,7 +19,7 @@ Here are the key interactions the Game Frontend has with Open Match:
 The Game Frontend adds a new matchmaking request to Open Match by creating a Ticket using the following API on Open Match Frontend:
 
 ```proto
-rpc CreateTicket(CreateTicketRequest) returns (CreateTicketResponse) {
+rpc CreateTicket(CreateTicketRequest) returns (Ticket) {
   option (google.api.http) = {
     post: "/v1/frontendservice/tickets"
     body: "*"
@@ -33,10 +33,25 @@ A Ticket represents a single matchmaking request in Open Match. It can represent
 
 ```proto
 message Ticket {
+  // Id represents an auto-generated Id issued by Open Match.
   string id = 1;
+
+  // An Assignment represents a game server assignment associated with a Ticket.
+  // Open Match does not require or inspect any fields on Assignment.
   Assignment assignment = 3;
+
+  // Search fields are the fields which Open Match is aware of, and can be used
+  // when specifying filters.
   SearchFields search_fields = 4;
+
+  // Customized information not inspected by Open Match, to be used by the match
+  // making function, evaluator, and components making calls to Open Match.
+  // Optional, depending on the requirements of the connected systems.
   map<string, google.protobuf.Any> extensions = 5;
+
+  // Create time represents the time at which this Ticket was created. It is
+  // populated by Open Match at the time of Ticket creation.
+  google.protobuf.Timestamp create_time = 6;
 }
 ```
 
@@ -73,7 +88,7 @@ Open Match does not guarantee persistent storage and hence should not be used as
 Once the player Assignment has been stored & communicated to the Game Client, the Game Frontend may delete the Ticket from Open Match. Here is the API exposed on Open Match Frontend to delete a Ticket:
 
 ```proto
-rpc DeleteTicket(DeleteTicketRequest) returns (DeleteTicketResponse) {
+rpc DeleteTicket(DeleteTicketRequest) returns (google.protobuf.Empty) {
   option (google.api.http) = {
     delete: "/v1/frontendservice/tickets/{ticket_id}"
   };

site/content/en/docs/Guides/api.md

@@ -65,12 +65,12 @@ func main() {
       },
     },
   }
-  resp, err := feClient.CreateTicket(sent)
+  ticket, err := feClient.CreateTicket(sent)
   if err != nil {
     log.Errorf("feClient.CreateTicket failed with %v", err)
   }
 
-  fmt.Println("Open Match assigned id %s to the ticket", resp.GetTicket().GetId())
+  fmt.Println("Open Match assigned id %s to the ticket", ticket.GetId())
 }
 ```
 
@@ -117,12 +117,12 @@ func main() {
     log.Errorf("ioutil.ReadAll(resp.Body) failed with %v; want success", err)
   }
   // Unmarshal the response to a Go struct
-  var received *pb.CreateTicketResponse
+  var received *pb.Ticket
   if err := jsonpb.UnmarshalString(string(buf), received); err != nil {
     log.Errorf("jsonpb.UnmarshalString(%s, &msg) failed with %v; want success", buf, err)
   }
 
-  fmt.Println("Open Match assigned id %s to the ticket", received.GetTicket().GetId())
+  fmt.Println("Open Match assigned id %s to the ticket", received.GetId())
 }
 ```
 

site/content/en/docs/Guides/best_practices.md

@@ -41,7 +41,9 @@ server := grpc.NewServer(
 
 ## Enable the client-side load balancer for your gRPC client
 You need to add the a load balancer config to your gRPC client to enable Open Match's horizontal scaling feature. Here are the two steps to turn on this setting and make it compatible with Kubernetes' environment.
+
 1. Changing the Kubernetes' services of your customized components into `HeadlessService`s, if any. e.g.:
+
     ```yaml
     # https://kubernetes.io/docs/concepts/services-networking/service/#headless-services
     spec:
@@ -52,7 +54,9 @@ You need to add the a load balancer config to your gRPC client to enable Open Ma
       clusterIP: None
       type: ClusterIP
     ```
+
 2. Using gRPC's DNS resolver when creating your clients and enable the client side load balancer:
+
     ```go
     import (
 	    "google.golang.org/grpc/resolver"