pages_deployment_configs_values

APIs.ioEngineeringPlatform

Properties

Name Type Description
ai_bindings object Constellation bindings used for Pages Functions.
analytics_engine_datasets object Analytics Engine bindings used for Pages Functions.
browsers object Browser bindings used for Pages Functions.
compatibility_date string Compatibility date used for Pages Functions.
compatibility_flags array Compatibility flags used for Pages Functions.
d1_databases object D1 databases used for Pages Functions.
durable_object_namespaces object Durabble Object namespaces used for Pages Functions.
env_vars object Environment variables for build configs.
hyperdrive_bindings object Hyperdrive bindings used for Pages Functions.
kv_namespaces object KV namespaces used for Pages Functions.
mtls_certificates object mTLS bindings used for Pages Functions.
placement object Placement setting used for Pages Functions.
queue_producers object Queue Producer bindings used for Pages Functions.
r2_buckets object R2 buckets used for Pages Functions.
services object Services used for Pages Functions.
vectorize_bindings object Vectorize bindings used for Pages Functions.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-pages-deployment-configs-values-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pages_deployment_configs_values",
  "title": "pages_deployment_configs_values",
  "properties": {
    "ai_bindings": {
      "additionalProperties": {
        "description": "AI binding.",
        "nullable": true,
        "properties": {
          "project_id": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "Constellation bindings used for Pages Functions.",
      "example": {
        "AI_BINDING": {
          "project_id": "some-project-id"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "analytics_engine_datasets": {
      "additionalProperties": {
        "description": "Analytics Engine binding.",
        "nullable": true,
        "properties": {
          "dataset": {
            "description": "Name of the dataset.",
            "example": "api_analytics",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "Analytics Engine bindings used for Pages Functions.",
      "example": {
        "ANALYTICS_ENGINE_BINDING": {
          "dataset": "api_analytics"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "browsers": {
      "additionalProperties": {
        "description": "Browser binding.",
        "nullable": true,
        "type": "object"
      },
      "description": "Browser bindings used for Pages Functions.",
      "example": {
        "BROWSER": {}
      },
      "nullable": true,
      "type": "object"
    },
    "compatibility_date": {
      "description": "Compatibility date used for Pages Functions.",
      "example": "2022-01-01",
      "type": "string"
    },
    "compatibility_flags": {
      "description": "Compatibility flags used for Pages Functions.",
      "example": [
        "url_standard"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "d1_databases": {
      "additionalProperties": {
        "description": "D1 binding.",
        "nullable": true,
        "properties": {
          "id": {
            "description": "UUID of the D1 database.",
            "example": "445e2955-951a-43f8-a35b-a4d0c8138f63",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "D1 databases used for Pages Functions.",
      "example": {
        "D1_BINDING": {
          "id": "445e2955-951a-43f8-a35b-a4d0c8138f63"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "durable_object_namespaces": {
      "additionalProperties": {
        "description": "Durabble Object binding.",
        "nullable": true,
        "properties": {
          "namespace_id": {
            "description": "ID of the Durabble Object namespace.",
            "example": "5eb63bbbe01eeed093cb22bb8f5acdc3",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "Durabble Object namespaces used for Pages Functions.",
      "example": {
        "DO_BINDING": {
          "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "env_vars": {
      "additionalProperties": {
        "description": "Environment variable.",
        "example": {
          "type": "plain_text",
          "value": "hello world"
        },
        "nullable": true,
        "properties": {
          "type": {
            "description": "The type of environment variable.",
            "enum": [
              "plain_text",
              "secret_text"
            ],
            "type": "string"
          },
          "value": {
            "description": "Environment variable value.",
            "type": "string"
          }
        },
        "required": [
          "value"
        ],
        "type": "object"
      },
      "description": "Environment variables for build configs.",
      "nullable": true,
      "type": "object"
    },
    "hyperdrive_bindings": {
      "additionalProperties": {
        "description": "Hyperdrive binding.",
        "nullable": true,
        "properties": {
          "id": {
            "example": "a76a99bc342644deb02c38d66082262a",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "Hyperdrive bindings used for Pages Functions.",
      "example": {
        "HYPERDRIVE": {
          "id": "a76a99bc342644deb02c38d66082262a"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "kv_namespaces": {
      "additionalProperties": {
        "description": "KV namespace binding.",
        "nullable": true,
        "properties": {
          "namespace_id": {
            "description": "ID of the KV namespace.",
            "example": "5eb63bbbe01eeed093cb22bb8f5acdc3",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "KV namespaces used for Pages Functions.",
      "example": {
        "KV_BINDING": {
          "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "mtls_certificates": {
      "additionalProperties": {
        "description": "mTLS binding.",
        "nullable": true,
        "properties": {
          "certificate_id": {
            "example": "d7cdd17c-916f-4cb7-aabe-585eb382ec4e",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "mTLS bindings used for Pages Functions.",
      "example": {
        "MTLS": {
          "certificate_id": "d7cdd17c-916f-4cb7-aabe-585eb382ec4e"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "placement": {
      "description": "Placement setting used for Pages Functions.",
      "example": {
        "mode": "smart"
      },
      "nullable": true,
      "properties": {
        "mode": {
          "description": "Placement mode.",
          "example": "smart",
          "type": "string"
        }
      },
      "type": "object"
    },
    "queue_producers": {
      "additionalProperties": {
        "description": "Queue Producer binding.",
        "nullable": true,
        "properties": {
          "name": {
            "description": "Name of the Queue.",
            "example": "some-queue",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "Queue Producer bindings used for Pages Functions.",
      "example": {
        "QUEUE_PRODUCER_BINDING": {
          "name": "some-queue"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "r2_buckets": {
      "additionalProperties": {
        "description": "R2 binding.",
        "nullable": true,
        "properties": {
          "jurisdiction": {
            "description": "Jurisdiction of the R2 bucket.",
            "example": "eu",
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Name of the R2 bucket.",
            "example": "some-bucket",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "R2 buckets used for Pages Functions.",
      "example": {
        "R2_BINDING": {
          "name": "some-bucket"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "services": {
      "additionalProperties": {
        "description": "Service binding.",
        "nullable": true,
        "properties": {
          "entrypoint": {
            "description": "The entrypoint to bind to.",
            "nullable": true,
            "type": "string"
          },
          "environment": {
            "description": "The Service environment.",
            "type": "string"
          },
          "service": {
            "description": "The Service name.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "Services used for Pages Functions.",
      "example": {
        "SERVICE_BINDING": {
          "entrypoint": "MyHandler",
          "environment": "production",
          "service": "example-worker"
        }
      },
      "nullable": true,
      "type": "object"
    },
    "vectorize_bindings": {
      "additionalProperties": {
        "description": "Vectorize binding.",
        "nullable": true,
        "properties": {
          "index_name": {
            "example": "my_index",
            "type": "string"
          }
        },
        "type": "object"
      },
      "description": "Vectorize bindings used for Pages Functions.",
      "example": {
        "VECTORIZE": {
          "index_name": "my_index"
        }
      },
      "nullable": true,
      "type": "object"
    }
  },
  "type": "object"
}