workos-office / docs /10_API_Gateway /modules.schema.json
dellweb3's picture
Work OS validated demo local-v0.8
99caad5 verified
Raw History Blame Contribute Delete
6.72 kB
{
"type": "object",
"properties": {
"config_revision": {
"type": "string",
"minLength": 1
},
"environment": {
"enum": [
"pc",
"cloud",
"intranet"
]
},
"modules": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"module_id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]*$"
},
"adapter_key": {
"type": "string",
"minLength": 1
},
"contract_version": {
"type": "string",
"const": "1"
},
"enabled": {
"type": "boolean"
},
"depends_on": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
},
"endpoint_ref": {
"type": "string",
"pattern": "^env:[A-Z][A-Z0-9_]*$"
}
},
"required": [
"module_id",
"adapter_key",
"contract_version",
"enabled",
"depends_on"
],
"additionalProperties": false
}
},
"gateway": {
"type": "object",
"properties": {
"bind_host": {
"type": "string",
"minLength": 1
},
"bind_port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"api_processes": {
"type": "integer",
"minimum": 1
},
"allowed_hosts": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
},
"trusted_proxy_ips": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
},
"json_max_bytes": {
"type": "integer",
"minimum": 1
},
"file_max_bytes": {
"type": "integer",
"minimum": 1
},
"multipart_max_bytes": {
"type": "integer",
"minimum": 1
},
"metadata_max_bytes": {
"type": "integer",
"minimum": 1
},
"skill_max_utf8_bytes": {
"type": "integer",
"minimum": 1
},
"request_deadline_seconds": {
"type": "integer",
"minimum": 1
},
"upload_deadline_seconds": {
"type": "integer",
"minimum": 1
},
"sse": {
"type": "object",
"properties": {
"heartbeat_seconds": {
"type": "integer",
"minimum": 1
},
"max_connection_seconds": {
"type": "integer",
"minimum": 1
},
"max_connections_per_user": {
"type": "integer",
"minimum": 1
},
"max_connections_per_process": {
"type": "integer",
"minimum": 1
},
"queue_max_events": {
"type": "integer",
"minimum": 1
},
"queue_max_bytes": {
"type": "integer",
"minimum": 1
},
"poll_interval_seconds": {
"type": "integer",
"minimum": 1
},
"poll_page_size": {
"type": "integer",
"minimum": 1
}
},
"required": [
"heartbeat_seconds",
"max_connection_seconds",
"max_connections_per_user",
"max_connections_per_process",
"queue_max_events",
"queue_max_bytes",
"poll_interval_seconds",
"poll_page_size"
],
"additionalProperties": false
},
"rate_limit": {
"type": "object",
"properties": {
"per_user_per_minute": {
"type": "integer",
"minimum": 1
},
"burst": {
"type": "integer",
"minimum": 1
},
"login_per_ip_per_minute": {
"type": "integer",
"minimum": 1
},
"run_start_per_user_per_minute": {
"type": "integer",
"minimum": 1
}
},
"required": [
"per_user_per_minute",
"burst",
"login_per_ip_per_minute",
"run_start_per_user_per_minute"
],
"additionalProperties": false
}
},
"required": [
"bind_host",
"bind_port",
"api_processes",
"allowed_hosts",
"allowed_origins",
"trusted_proxy_ips",
"json_max_bytes",
"file_max_bytes",
"multipart_max_bytes",
"metadata_max_bytes",
"skill_max_utf8_bytes",
"request_deadline_seconds",
"upload_deadline_seconds",
"sse",
"rate_limit"
],
"additionalProperties": false
},
"secret_refs": {
"type": "object",
"properties": {
"demo_signing_key": {
"type": "string",
"minLength": 1
},
"demo_accounts": {
"type": "string",
"minLength": 1
},
"database_url": {
"type": "string",
"minLength": 1
},
"qwen_api_key": {
"type": "string",
"minLength": 1
},
"wecom_credentials": {
"type": "string",
"minLength": 1
}
},
"required": [
"demo_signing_key",
"demo_accounts",
"database_url",
"qwen_api_key",
"wecom_credentials"
],
"additionalProperties": false
}
},
"required": [
"config_revision",
"environment",
"modules",
"gateway",
"secret_refs"
],
"additionalProperties": false,
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Work OS module composition configuration v1"
}