APIs.io Engineering Platform · Schema
DeploymentCanarySettings
The input configuration for a canary deployment.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| percentTraffic | object | |
| stageVariableOverrides | object | |
| useStageCache | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/DeploymentCanarySettings",
"title": "DeploymentCanarySettings",
"type": "object",
"properties": {
"percentTraffic": {
"allOf": [
{
"$ref": "#/components/schemas/Double"
},
{
"description": "The percentage (0.0-100.0) of traffic routed to the canary deployment."
}
]
},
"stageVariableOverrides": {
"allOf": [
{
"$ref": "#/components/schemas/MapOfStringToString"
},
{
"description": "A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not."
}
]
}
},
"description": "The input configuration for a canary deployment."
}