Commit cd34b7aa authored by Mo Firouz's avatar Mo Firouz
Browse files

Clarify description for duration and start active fields in API.

parent c288ecb2

api/api.pb.go

+4 −4
Original line number Diff line number Diff line
@@ -4234,9 +4234,9 @@ type Tournament struct { 
	MaxNumScore uint32 `protobuf:"varint,8,opt,name=max_num_score,json=maxNumScore,proto3" json:"max_num_score,omitempty"`

	// True if the tournament is active and can enter. A computed value.

	CanEnter bool `protobuf:"varint,9,opt,name=can_enter,json=canEnter,proto3" json:"can_enter,omitempty"`

	// The UNIX timestamp when the tournament stops being active until next reset. A computed value.

	// The UNIX time when the tournament stops being active until next reset. A computed value.

	EndActive uint32 `protobuf:"varint,10,opt,name=end_active,json=endActive,proto3" json:"end_active,omitempty"`

	// The UNIX timestamp when the tournament is next playable. A computed value.

	// The UNIX time when the tournament is next playable. A computed value.

	NextReset uint32 `protobuf:"varint,11,opt,name=next_reset,json=nextReset,proto3" json:"next_reset,omitempty"`

	// Additional information stored as a JSON object.

	Metadata string `protobuf:"bytes,12,opt,name=metadata,proto3" json:"metadata,omitempty"`
@@ -4246,9 +4246,9 @@ type Tournament struct { 
	StartTime *timestamp.Timestamp `protobuf:"bytes,14,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`

	// The UNIX time when the tournament will be stopped.

	EndTime *timestamp.Timestamp `protobuf:"bytes,15,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`

	// The UNIX timestamp for duration of a tournament.

	// Duration of the tournament in seconds.

	Duration uint32 `protobuf:"varint,16,opt,name=duration,proto3" json:"duration,omitempty"`

	// The UNIX timestamp when the tournament start being active. A computed value.

	// The UNIX time when the tournament start being active. A computed value.

	StartActive          uint32   `protobuf:"varint,17,opt,name=start_active,json=startActive,proto3" json:"start_active,omitempty"`

	XXX_NoUnkeyedLiteral struct{} `json:"-"`

	XXX_unrecognized     []byte   `json:"-"`

api/api.proto

+4 −4
Original line number Diff line number Diff line
@@ -770,9 +770,9 @@ message Tournament { 
  uint32 max_num_score = 8;

  // True if the tournament is active and can enter. A computed value.

  bool can_enter = 9;

  // The UNIX timestamp when the tournament stops being active until next reset. A computed value.

  // The UNIX time when the tournament stops being active until next reset. A computed value.

  uint32 end_active = 10;

  // The UNIX timestamp when the tournament is next playable. A computed value.

  // The UNIX time when the tournament is next playable. A computed value.

  uint32 next_reset = 11;

  // Additional information stored as a JSON object.

  string metadata = 12;
@@ -782,9 +782,9 @@ message Tournament { 
  google.protobuf.Timestamp start_time = 14;

  // The UNIX time when the tournament will be stopped.

  google.protobuf.Timestamp end_time = 15;

  // The UNIX timestamp for duration of a tournament.

  // Duration of the tournament in seconds.

  uint32 duration = 16;

  // The UNIX timestamp when the tournament start being active. A computed value.

  // The UNIX time when the tournament start being active. A computed value.

  uint32 start_active = 17;

}

apigrpc/apigrpc.swagger.json

+4 −4
Original line number Diff line number Diff line
@@ -3013,12 +3013,12 @@ 
        "end_active": {

          "type": "integer",

          "format": "int64",

          "description": "The UNIX timestamp when the tournament stops being active until next reset. A computed value."

          "description": "The UNIX time when the tournament stops being active until next reset. A computed value."

        },

        "next_reset": {

          "type": "integer",

          "format": "int64",

          "description": "The UNIX timestamp when the tournament is next playable. A computed value."

          "description": "The UNIX time when the tournament is next playable. A computed value."

        },

        "metadata": {

          "type": "string",
@@ -3042,12 +3042,12 @@ 
        "duration": {

          "type": "integer",

          "format": "int64",

          "description": "The UNIX timestamp for duration of a tournament."

          "description": "Duration of the tournament in seconds."

        },

        "start_active": {

          "type": "integer",

          "format": "int64",

          "description": "The UNIX timestamp when the tournament start being active. A computed value."

          "description": "The UNIX time when the tournament start being active. A computed value."

        }

      },

      "description": "A tournament on the server."