Skip to content

DON'T SUBMIT: update quota api. #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

DON'T SUBMIT: update quota api. #178

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8912b3a
update quota api.
qiwzhang Sep 19, 2017
c30d78c
add referenced_attributes.
qiwzhang Sep 19, 2017
8034b39
update the api.
qiwzhang Sep 19, 2017
5c6d2dc
update comment
qiwzhang Sep 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions mixer/v1/check.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ message CheckRequest {

// The individual quotas to allocate
map<string, QuotaParams> quotas = 4 [(gogoproto.nullable) = false];

// If true, server should check quota requirements, return the result
// in quota_requirements fields in the CheckResponse.
// If true, "quotas" field is ignored, server should charge quotas based on the new
// quota requirements, and return the charging results in "quotas" fields in CheckResponse.
bool check_quota_requirement = 5;
}

message CheckResponse {
Expand Down Expand Up @@ -93,11 +99,35 @@ message CheckResponse {
ReferencedAttributes referenced_attributes = 5 [(gogoproto.nullable) = false];
}

message QuotaRequirement {
message Requirement {
// the quota metric name.
string name = 1;

// The amount to charge.
int64 amount = 2;
}

// Return required qutoas and their amounts.
// Empty list is a valid result. It means quota is not required for the call.
repeated Requirement requirements = 1;

// The amount of time for which this result can be considered valid.
google.protobuf.Duration valid_duration = 2 [(gogoproto.nullable) = false, (gogoproto.stdduration) = true];

// The total set of attributes that were used in producing the result
// Client should use used attributes to calculate key for caching the result.
ReferencedAttributes referenced_attributes = 3 [(gogoproto.nullable) = false];
}

// The precondition check results.
PreconditionResult precondition = 2 [(gogoproto.nullable) = false];

// The resulting quota, one entry per requested quota.
map<string, QuotaResult> quotas = 3 [(gogoproto.nullable) = false];

// Return quota requirements.
QuotaRequirement quota_requirements = 4;
}

// Describes the attributes that were used to determine the response.
Expand Down