APIs.io Engineering Platform · Schema
CanarySettings
Configuration settings of a canary deployment.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| percentTraffic | object | |
| deploymentId | object | |
| stageVariableOverrides | object | |
| useStageCache | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CanarySettings",
"title": "CanarySettings",
"type": "object",
"properties": {
"percentTraffic": {
"allOf": [
{
"$ref": "#/components/schemas/Double"
},
{
"description": "The percent (0-100) of traffic diverted to a canary deployment."
}
]
},
"deploymentId": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The ID of the canary deployment."
}
]
},
"stageVariableOverrides": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values."
}
]
},
"useStageCache": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not."
}
]
}
},
"description": "Configuration settings of a canary deployment."
}