QuotaSettings

Quotas configured for a usage plan.

APIs.ioEngineeringPlatform

Properties

Name Type Description
limit object
offset object
period object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-quotasettings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QuotaSettings",
  "title": "QuotaSettings",
  "type": "object",
  "properties": {
    "limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The target maximum number of requests that can be made in a given time period."
        }
      ]
    },
    "offset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The number of requests subtracted from the given limit in the initial time period."
        }
      ]
    },
    "period": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QuotaPeriodType"
        },
        {
          "description": "The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"."
        }
      ]
    }
  },
  "description": "Quotas configured for a usage plan."
}