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
|
// Copyright 2020 Northern.tech AS
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package ratelimits
import (
"encoding/json"
)
// ApiBurst defines minimal interval (seconds) between subsequent calls to action on uri
type ApiBurst struct {
Action string `json:"action" bson:"action"`
Uri string `json:"uri" bson:"uri"`
MinIntervalSec int `json:"min_interval_sec" bson:"min_interval_sec"`
}
// ApiQuota defines the ratelimit quota as max number of calls in a given time interval (in seconds)
// MaxCalls == 0 means 'no quota limit'
type ApiQuota struct {
MaxCalls int `json:"max_calls" bson:"max_calls"`
IntervalSec int `json:"interval_sec" bson:"interval_sec"`
}
// ApiLimits combines burst limits and usage quota limits
type ApiLimits struct {
ApiBursts []ApiBurst `json:"bursts" bson:"bursts"`
ApiQuota ApiQuota `json:"quota" bson:"quota"`
}
// MarshalJSON makes sure even defaut nil ApiLimits.ApiBursts are actually empty lists
func (al ApiLimits) MarshalJSON() ([]byte, error) {
if al.ApiBursts == nil {
al.ApiBursts = make([]ApiBurst, 0)
}
type Copy ApiLimits
copy := struct {
Copy
}{
Copy: (Copy)(al),
}
return json.Marshal(©)
}
|