- หน้าแรก
- API Enriched
- ส่วนขยาย
- แคตตาล็อกส่วนขยาย Enrichment
แคตตาล็อกส่วนขยาย Enrichment
แหล่งข้อมูลหลักสำหรับส่วนขยาย x-* ทุกรายการที่ปรากฏใน
docs/specifications/api/*.json ความสอดคล้องกับ
scripts/utils/extension_constants.py ถูกบังคับใช้โดย
tests/test_extension_catalog.py
ส่วนขยายสามประเภทได้รับการจัดทำเอกสารไว้ที่นี่:
- ฉีดเข้ามาที่นี่ — ส่วนขยายที่ enricher ของเราเพิ่มเข้ามา (
x-f5xc-*และx-ves-cli-*/x-ves-field-*/x-ves-operation-*/ discovery variants) เหล่านี้คือส่วนขยายที่เครื่องมือ downstream ควรนำไปใช้ - ส่งผ่านจาก upstream — ส่วนขยายที่ F5 ส่งออกมาในสเปคต้นทาง
และเราเก็บรักษาไว้โดยไม่เปลี่ยนแปลง (
x-ves-proto-*,x-displaynameเป็นต้น) จัดทำเอกสารเพื่อความโปร่งใส แต่ไม่ได้ควบคุมโดย repo นี้ - ฉีดในอนาคต — ยังไม่ได้ส่งออก; จัดทำเอกสารทันทีที่ enricher เริ่มผลิตขึ้นมา (ไม่มีผลบังคับใช้ในการป้อนข้อมูลเริ่มต้น)
โครงสร้างรายการ
หัวข้อที่มีชื่อว่า “โครงสร้างรายการ”ทุกรายการด้านล่างมีรูปแบบนี้อย่างแน่นอน การทดสอบความสอดคล้องใน
tests/test_extension_catalog.py ยอมรับเนื้อหาของส่วนที่สั้นกระชับ
ตราบเท่าที่ส่วนหัว ### x-name มีอยู่ และ
แฟล็ก Pass-through from upstream: มีค่าเป็น yes หรือ no
### x-<name>- **Applied at:** <schema | parameter | operation | path-item | info | response>- **Purpose:** <one sentence>- **Consumers:** <CLI | VSCode | Terraform | Web UI | multiple | N/A>- **Value type:** <string | number | boolean | object | array>- **Value schema:** <JSON Schema snippet, or N/A>- **Injected by:** <scripts/utils/<enricher>.py, or "upstream">- **Driven by config:** <config/<file>.yaml, or "hardcoded", or "upstream">- **Example:** <short snippet>- **Pass-through from upstream:** <yes/no>ฉีดเข้ามา — ระดับสเปค (ส่วน info)
หัวข้อที่มีชื่อว่า “ฉีดเข้ามา — ระดับสเปค (ส่วน info)”x-f5xc-cli-domain
หัวข้อที่มีชื่อว่า “x-f5xc-cli-domain”- Applied at: info
- Purpose: ระบุ slug ของโดเมน CLI (เช่น
http_loadbalancer) สำหรับสเปคที่เพิ่มประสิทธิภาพแล้ว - Consumers: CLI
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: hardcoded
- Example:
"x-f5xc-cli-domain": "http_loadbalancer" - Pass-through from upstream: no
x-f5xc-cli-metadata
หัวข้อที่มีชื่อว่า “x-f5xc-cli-metadata”- Applied at: info
- Purpose: บล็อกเมตาดาตาสำหรับ CLI ทั้งหมด (ชื่อเครื่องมือ, 힌트เวอร์ชัน, การจัดกลุ่มโดเมน)
- Consumers: CLI
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/merge_specs.py
- Driven by config: config/cli_metadata.yaml
- Example:
"x-f5xc-cli-metadata": {"tool": "xcsh", "domain": "http_loadbalancer"} - Pass-through from upstream: no
x-f5xc-upstream-timestamp
หัวข้อที่มีชื่อว่า “x-f5xc-upstream-timestamp”- Applied at: info
- Purpose: Timestamp ของสเปคต้นทาง upstream ที่ใช้สร้างไฟล์ที่เพิ่มประสิทธิภาพแล้ว
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string", "format": "date-time"} - Injected by: scripts/merge_specs.py
- Driven by config: hardcoded
- Example:
"x-f5xc-upstream-timestamp": "2026-04-21T12:00:00Z" - Pass-through from upstream: no
x-f5xc-upstream-etag
หัวข้อที่มีชื่อว่า “x-f5xc-upstream-etag”- Applied at: info
- Purpose: ETag ของ asset การเผยแพร่สเปคต้นทาง upstream
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: hardcoded
- Example:
"x-f5xc-upstream-etag": "\"abc123\"" - Pass-through from upstream: no
x-f5xc-enriched-version
หัวข้อที่มีชื่อว่า “x-f5xc-enriched-version”- Applied at: info
- Purpose: เวอร์ชัน Semantic ที่ประทับลงบนสเปคที่เพิ่มประสิทธิภาพแล้วโดย pipeline
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: hardcoded
- Example:
"x-f5xc-enriched-version": "3.2.1" - Pass-through from upstream: no
x-f5xc-glossary
หัวข้อที่มีชื่อว่า “x-f5xc-glossary”- Applied at: info
- Purpose: บล็อกคำศัพท์ด้านการสร้างแบรนด์/คำศัพท์เฉพาะที่ใช้กับสเปคของแต่ละโดเมน
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/branding.py
- Driven by config: config/branding.yaml
- Example:
"x-f5xc-glossary": {"XC": "F5 Distributed Cloud"} - Pass-through from upstream: no
x-f5xc-discovered-at
หัวข้อที่มีชื่อว่า “x-f5xc-discovered-at”- Applied at: info
- Purpose: Timestamp เมื่อดำเนินการ discovery pass ของ live API
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string", "format": "date-time"} - Injected by: scripts/utils/discovery_enricher.py
- Driven by config: config/discovery.yaml
- Example:
"x-f5xc-discovered-at": "2026-04-21T09:15:00Z" - Pass-through from upstream: no
x-f5xc-api-url
หัวข้อที่มีชื่อว่า “x-f5xc-api-url”- Applied at: info
- Purpose: URL พื้นฐานของ live API ที่ถูกตรวจสอบระหว่าง discovery
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string", "format": "uri"} - Injected by: scripts/utils/discovery_enricher.py
- Driven by config: config/discovery.yaml
- Example:
"x-f5xc-api-url": "https://f5-amer-ent.console.ves.volterra.io" - Pass-through from upstream: no
x-f5xc-api-reference-url
หัวข้อที่มีชื่อว่า “x-f5xc-api-reference-url”- Applied at: info
- Purpose: URL ไปยังหน้าเอกสารอ้างอิง API ที่โฮสต์ไว้สำหรับโดเมนนี้
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string", "format": "uri"} - Injected by: scripts/utils/external_docs_enricher.py
- Driven by config: none (derived from domain name)
- Example:
"x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" - Pass-through from upstream: no
x-f5xc-response-time-ms
หัวข้อที่มีชื่อว่า “x-f5xc-response-time-ms”- Applied at: info
- Purpose: เวลาตอบสนองที่สังเกตได้ (ms) สำหรับ API ที่ถูกตรวจสอบระหว่าง discovery
- Consumers: multiple
- Value type: number
- Value schema:
{"type": "number"} - Injected by: scripts/utils/discovery_enricher.py
- Driven by config: config/discovery.yaml
- Example:
"x-f5xc-response-time-ms": 42 - Pass-through from upstream: no
x-f5xc-best-practices
หัวข้อที่มีชื่อว่า “x-f5xc-best-practices”- Applied at: info
- Purpose: คำแนะนำแนวทางปฏิบัติที่ดีที่สุดที่คัดเลือกแล้วสำหรับโดเมน
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "object"}} - Injected by: scripts/utils/best_practices_enricher.py
- Driven by config: config/best_practices.yaml
- Example:
"x-f5xc-best-practices": [{"id": "bp-1", "text": "Prefer HTTPS"}] - Pass-through from upstream: no
x-f5xc-guided-workflows
หัวข้อที่มีชื่อว่า “x-f5xc-guided-workflows”- Applied at: info
- Purpose: เวิร์กโฟลว์แบบขั้นตอนที่มีชื่อเพื่อทำงานทั่วไปในโดเมน
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "object"}} - Injected by: scripts/utils/guided_workflow_enricher.py
- Driven by config: config/guided_workflows.yaml
- Example:
"x-f5xc-guided-workflows": [{"name": "create-lb", "steps": [...]}] - Pass-through from upstream: no
x-f5xc-acronyms
หัวข้อที่มีชื่อว่า “x-f5xc-acronyms”- Applied at: info
- Purpose: ตารางการขยายตัวย่อสำหรับแต่ละโดเมน
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object", "additionalProperties": {"type": "string"}} - Injected by: scripts/utils/acronym_enricher.py
- Driven by config: config/acronyms.yaml
- Example:
"x-f5xc-acronyms": {"LB": "Load Balancer"} - Pass-through from upstream: no
x-f5xc-console-navigation
หัวข้อที่มีชื่อว่า “x-f5xc-console-navigation”- Applied at: spec info
- Purpose: ต้นไม้การนำทางคอนโซลทั่วทั้งระบบ — ลำดับชั้น workspace และเมนู
- Consumers: console-catalog, xcsh, browser-automation
- Value type: object
- Value schema:
{"type": "object", "properties": {"workspaces": "object"}} - Injected by: scripts/utils/console_ui_enricher.py
- Driven by config: config/console_ui.yaml
- Example:
"x-f5xc-console-navigation": {"workspaces": {"web-app-and-api-protection": {"label": "Web App & API Protection", "route_prefix": "/web/workspaces/web-app-and-api-protection"}}} - Pass-through from upstream: no
ฉีดเข้ามา — ระดับ schema (component schemas)
หัวข้อที่มีชื่อว่า “ฉีดเข้ามา — ระดับ schema (component schemas)”x-f5xc-minimum-configuration
หัวข้อที่มีชื่อว่า “x-f5xc-minimum-configuration”- Applied at: schema
- Purpose: ชุดฟิลด์ขั้นต่ำที่จำเป็นเพื่อ POST/PUT ทรัพยากรนี้ให้สำเร็จ
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/minimum_configuration_enricher.py
- Driven by config: config/minimum_configs.yaml
- Example:
"x-f5xc-minimum-configuration": {"required_fields": ["name"]} - Pass-through from upstream: no
x-f5xc-namespace-profile
หัวข้อที่มีชื่อว่า “x-f5xc-namespace-profile”- Applied at: info
- Purpose: ให้ metadata ด้านข้อจำกัด namespace, คำแนะนำ, และการจัดประเภทสำหรับทรัพยากร
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object", "properties": {"constraint": {"type": "object"}, "recommendation": {"type": "object"}, "classification": {"type": "object"}}} - Injected by: scripts/utils/namespace_profile_enricher.py
- Driven by config: config/namespace_profile.yaml
- Example:
"x-f5xc-namespace-profile": {"constraint": {"allowed": ["system", "shared", "user"]}, "recommendation": {"default": "shared"}, "classification": {"multi_tenant_pattern": "shared-ref"}} - Pass-through from upstream: no
x-f5xc-displayorder
หัวข้อที่มีชื่อว่า “x-f5xc-displayorder”- Applied at: schema
- Purpose: ลำดับที่แนะนำของ properties สำหรับการแสดงผลใน UI/CLI
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-displayorder": ["name", "description", "spec"] - Pass-through from upstream: no
x-f5xc-terraform-resource
หัวข้อที่มีชื่อว่า “x-f5xc-terraform-resource”- Applied at: schema
- Purpose: ชื่อประเภท Terraform resource ที่แมปกับ schema นี้
- Consumers: Terraform
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-terraform-resource": "volterra_http_loadbalancer" - Pass-through from upstream: no
x-f5xc-display-name
หัวข้อที่มีชื่อว่า “x-f5xc-display-name”- Applied at: schema
- Purpose: ชื่อที่แสดงผลแบบอ่านง่ายสำหรับ resource schema (แทนที่การสร้างอัตโนมัติ)
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-display-name": "HTTP Load Balancer" - Pass-through from upstream: no
x-f5xc-console
หัวข้อที่มีชื่อว่า “x-f5xc-console”- Applied at: schema
- Purpose: การนำทาง UI คอนโซล, การกำหนดเส้นทาง, และโครงสร้างฟอร์มสำหรับทรัพยากรนี้
- Consumers: console-catalog, xcsh, vscode-xcsh, browser-automation
- Value type: object
- Value schema:
{"type": "object", "properties": {"workspace": "string", "menu_path": "array", "route_pattern": "string", "breadcrumbs": "array", "add_action": "object", "form_sections": "array", "metadata": "object"}} - Injected by: scripts/utils/console_ui_enricher.py
- Driven by config: config/console_ui.yaml
- Example:
"x-f5xc-console": {"workspace": "web-app-and-api-protection", "menu_path": ["Manage", "Load Balancers", "HTTP Load Balancers"]} - Pass-through from upstream: no
x-f5xc-action
หัวข้อที่มีชื่อว่า “x-f5xc-action”- Applied at: schema
- Purpose: ทำเครื่องหมายสคีมาที่การดำเนินการเป็นทรัพยากรแบบแอ็กชัน เช่น
approveเพื่อให้ codegen สร้างทรัพยากรแบบแอ็กชันแทน CRUD - Consumers: Terraform
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/schema_override_enricher.py
- Driven by config: config/schema_overrides.yaml
- Example:
"x-f5xc-action": "approve" - Pass-through from upstream: no
ฉีดเข้ามา — ระดับ property
หัวข้อที่มีชื่อว่า “ฉีดเข้ามา — ระดับ property”x-f5xc-description
หัวข้อที่มีชื่อว่า “x-f5xc-description”- Applied at: schema property
- Purpose: คำอธิบาย property ที่เพิ่มประสิทธิภาพแล้วซึ่งเสริมจาก
descriptionupstream - Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_descriptions.yaml
- Example:
"x-f5xc-description": "Fully-qualified domain name used for TLS SNI." - Pass-through from upstream: no
x-f5xc-validation
หัวข้อที่มีชื่อว่า “x-f5xc-validation”- Applied at: schema property
- Purpose: กฎการตรวจสอบแบบ declarative ที่ได้มาจาก
ves.io.schema.rulesของ protobuf upstream - Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/validation_enricher.py
- Driven by config: config/validation_rules.yaml
- Example:
"x-f5xc-validation": {"min_len": 1, "max_len": 64} - Pass-through from upstream: no
x-f5xc-examples
หัวข้อที่มีชื่อว่า “x-f5xc-examples”- Applied at: schema property
- Purpose: ค่าตัวอย่างหลายรายการสำหรับ property
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array"} - Injected by: scripts/utils/resource_examples_enricher.py
- Driven by config: config/resource_examples.yaml
- Example:
"x-f5xc-examples": ["example.com", "api.example.com"] - Pass-through from upstream: no
x-f5xc-example
หัวข้อที่มีชื่อว่า “x-f5xc-example”- Applied at: schema property
- Purpose: ค่าตัวอย่างหลักเพียงค่าเดียว
- Consumers: multiple
- Value type: string
- Value schema:
{} - Injected by: scripts/utils/field_description_enricher.py
- Driven by config: config/field_descriptions.yaml
- Example:
"x-f5xc-example": "example.com" - Pass-through from upstream: no
x-f5xc-completion
หัวข้อที่มีชื่อว่า “x-f5xc-completion”- Applied at: schema property
- Purpose: คำแนะนำสำหรับการเติมข้อความอัตโนมัติใน shell (enum แบบ static หรือคำสั่งแบบ dynamic)
- Consumers: CLI
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-completion": {"source": "command", "cmd": "xcsh namespace list"} - Pass-through from upstream: no
x-f5xc-defaults
หัวข้อที่มีชื่อว่า “x-f5xc-defaults”- Applied at: schema property
- Purpose: ค่าเริ่มต้นที่จะแสดงในเอกสารและ UI ที่สร้างขึ้น
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-defaults": {"value": "default"} - Pass-through from upstream: no
x-f5xc-required-for-operations
หัวข้อที่มีชื่อว่า “x-f5xc-required-for-operations”- Applied at: schema property
- Purpose: แสดงรายการ HTTP operations (POST/PUT/…) ที่ต้องการ property นี้
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-required-for-operations": ["POST", "PUT"] - Pass-through from upstream: no
x-f5xc-required-for
หัวข้อที่มีชื่อว่า “x-f5xc-required-for”- Applied at: schema property
- Purpose: แสดงรายการการรวมกันของฟีเจอร์ที่มีชื่อซึ่งต้องการ property นี้
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/utils/minimum_configuration_enricher.py
- Driven by config: config/minimum_configs.yaml
- Example:
"x-f5xc-required-for": ["tls-origin", "mtls"] - Pass-through from upstream: no
x-f5xc-conditions
หัวข้อที่มีชื่อว่า “x-f5xc-conditions”- Applied at: schema property
- Purpose: ข้อกำหนดแบบมีเงื่อนไข (เช่น required เมื่อฟิลด์ sibling มีค่าเท่ากับ X)
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "object"}} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-conditions": [{"when": "tls.enabled == true", "require": "cert"}] - Pass-through from upstream: no
x-f5xc-deprecated
หัวข้อที่มีชื่อว่า “x-f5xc-deprecated”- Applied at: schema property
- Purpose: ประกาศการเลิกใช้งานพร้อมคำแนะนำการแทนที่
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/field_metadata_enricher.py
- Driven by config: config/field_metadata.yaml
- Example:
"x-f5xc-deprecated": {"since": "3.0.0", "use": "new_field"} - Pass-through from upstream: no
x-f5xc-server-default
หัวข้อที่มีชื่อว่า “x-f5xc-server-default”- Applied at: schema property
- Purpose: ค่าเริ่มต้นที่ server กำหนดเมื่อ client ละเว้น property
- Consumers: multiple
- Value type: string
- Value schema:
{} - Injected by: scripts/utils/default_value_enricher.py
- Driven by config: config/discovered_defaults.yaml
- Example:
"x-f5xc-server-default": "ROUND_ROBIN" - Pass-through from upstream: no
x-f5xc-recommended-value
หัวข้อที่มีชื่อว่า “x-f5xc-recommended-value”- Applied at: schema property
- Purpose: ค่าที่แนะนำสำหรับการใช้งานจริงสำหรับฟิลด์ที่ค่าเริ่มต้นของ server ไม่เหมาะสม
- Consumers: multiple
- Value type: string
- Value schema:
{} - Injected by: scripts/utils/default_value_enricher.py
- Driven by config: config/discovered_defaults.yaml
- Example:
"x-f5xc-recommended-value": "LEAST_REQUEST" - Pass-through from upstream: no
x-f5xc-recommended-oneof-variant
หัวข้อที่มีชื่อว่า “x-f5xc-recommended-oneof-variant”- Applied at: schema property
- Purpose: สำหรับบล็อก
oneOfระบุว่า variant ใดที่แนะนำ - Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/default_value_enricher.py
- Driven by config: config/discovered_defaults.yaml
- Example:
"x-f5xc-recommended-oneof-variant": "tls_parameters" - Pass-through from upstream: no
x-f5xc-conflicts-with
หัวข้อที่มีชื่อว่า “x-f5xc-conflicts-with”- Applied at: schema property
- Purpose: แสดงรายการ properties แบบ sibling ที่ไม่สามารถตั้งค่าพร้อมกับ property นี้ได้
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/utils/conflicts_with_enricher.py
- Driven by config: hardcoded
- Example:
"x-f5xc-conflicts-with": ["plaintext", "auto_cert"] - Pass-through from upstream: no
x-f5xc-references
หัวข้อที่มีชื่อว่า “x-f5xc-references”- Applied at: schema property
- Purpose: ประกาศประเภททรัพยากรที่อ้างถึงของฟิลด์ ObjectRefType (ทรัพยากรที่ชี้ไป ซึ่งต้องมีอยู่ก่อน) พร้อม oneOf choice-gating, required-for-create, และ cardinality — มิติการอ้างอิงทรัพยากรของโมเดล dependency
- Consumers: terraform, cli, mcp, IDE, ai-assistants
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "object", "properties": {"resource_kind": {"type": ["string", "null"]}, "field_path": {"type": "string"}, "gated_by": {"type": ["object", "null"]}, "required": {"type": "boolean"}, "cardinality": {"type": "string"}}}} - Injected by: scripts/utils/references_enricher.py
- Driven by config: config/resource_references.yaml
- Example:
"x-f5xc-references": [{"resource_kind": "app_firewall", "field_path": "app_firewall", "gated_by": {"choice": "waf_choice"}, "required": false, "cardinality": "single"}] - Pass-through from upstream: no
x-f5xc-field-examples
หัวข้อที่มีชื่อว่า “x-f5xc-field-examples”- Applied at: schema (CreateSpecType)
- Purpose: ค่าตัวอย่างในการสร้างแบบต่อฟิลด์ (แมป field_path แบบ flat กับค่า) ที่ได้มาจาก x-f5xc-minimum-configuration.example_yaml — แหล่งข้อมูลเดียวของค่าการสร้างแบบ deterministic สำหรับการสร้างฟอร์ม/เวิร์กโฟลว์ downstream
- Consumers: cli, workflow-generator, sweep, ai-assistants
- Value type: object
- Value schema:
{"type": "object", "additionalProperties": true} - Injected by: scripts/utils/example_field_enricher.py
- Driven by config: derived from x-f5xc-minimum-configuration.example_yaml
- Example:
"x-f5xc-field-examples": {"spec.port": 8080} - Pass-through from upstream: no
x-f5xc-requires
หัวข้อที่มีชื่อว่า “x-f5xc-requires”- Applied at: schema property
- Purpose: จัดทำเอกสาร dependencies ระหว่างฟิลด์ข้ามกัน ซึ่งฟิลด์หนึ่งต้องการให้ฟิลด์อื่นถูกตั้งค่าด้วย
- Consumers: compile_catalog.py, xcsh CLI
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "object", "properties": {"field": {"type": "string"}, "required": {"type": "boolean"}, "reason": {"type": "string"}}}} - Injected by: scripts/utils/dependency_enricher.py
- Driven by config: config/minimum_configs.yaml (dependencies section)
- Example:
"x-f5xc-requires": [{"field": "tls_config", "required": true, "reason": "use_tls requires tls_config sub-field"}] - Pass-through from upstream: no
x-f5xc-constraints
หัวข้อที่มีชื่อว่า “x-f5xc-constraints”- Applied at: schema property
- Purpose: ข้อจำกัดด้านตัวเลข/สตริงที่ได้มาจากการตรวจสอบ live API หรือ patterns แบบ static
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/constraint_enricher.py
- Driven by config: config/constraint_patterns.yaml
- Example:
"x-f5xc-constraints": {"min": 1, "max": 65535, "source": "live-api"} - Pass-through from upstream: no
x-f5xc-uniqueness
หัวข้อที่มีชื่อว่า “x-f5xc-uniqueness”- Applied at: schema property
- Purpose: ประกาศว่าฟิลด์ต้องมีค่าเฉพาะภายใน scope ของมันหรือไม่
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/uniqueness_enricher.py
- Driven by config: hardcoded
- Example:
"x-f5xc-uniqueness": {"scope": "namespace"} - Pass-through from upstream: no
x-f5xc-console-field
หัวข้อที่มีชื่อว่า “x-f5xc-console-field”- Applied at: schema property
- Purpose: metadata ของ widget ฟอร์มคอนโซลสำหรับ API property นี้
- Consumers: console-catalog, xcsh, browser-automation
- Value type: object
- Value schema:
{"type": "object", "properties": {"widget_type": "string", "label": "string", "default": "any", "selector": "string", "form_section": "string", "show_when": "object", "advanced": "boolean"}} - Injected by: scripts/utils/console_ui_enricher.py
- Driven by config: config/console_field_metadata.yaml
- Example:
"x-f5xc-console-field": {"widget_type": "listbox", "default": "HTTPS with Automatic Certificate", "form_section": "domains-and-lb-type"} - Pass-through from upstream: no
ฉีดเข้ามา — ระดับ operation
หัวข้อที่มีชื่อว่า “ฉีดเข้ามา — ระดับ operation”x-f5xc-required-fields
หัวข้อที่มีชื่อว่า “x-f5xc-required-fields”- Applied at: operation
- Purpose: ระบุชื่อฟิลด์ใน operation body ที่ต้องระบุเพื่อให้สำเร็จ
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/utils/operation_metadata_enricher.py
- Driven by config: config/operation_metadata.yaml
- Example:
"x-f5xc-required-fields": ["metadata.name", "spec.domains"] - Pass-through from upstream: no
x-f5xc-danger-level
หัวข้อที่มีชื่อว่า “x-f5xc-danger-level”- Applied at: operation
- Purpose: จำแนกระดับผลกระทบของ operation (low/medium/high/critical)
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string", "enum": ["low", "medium", "high", "critical"]} - Injected by: scripts/utils/operation_metadata_enricher.py
- Driven by config: config/operation_metadata.yaml
- Example:
"x-f5xc-danger-level": "high" - Pass-through from upstream: no
x-f5xc-confirmation-required
หัวข้อที่มีชื่อว่า “x-f5xc-confirmation-required”- Applied at: operation
- Purpose: ระบุว่า CLI/UI ควรแจ้งให้ผู้ใช้ยืนยันก่อนดำเนินการหรือไม่
- Consumers: multiple
- Value type: boolean
- Value schema:
{"type": "boolean"} - Injected by: scripts/utils/operation_metadata_enricher.py
- Driven by config: config/operation_metadata.yaml
- Example:
"x-f5xc-confirmation-required": true - Pass-through from upstream: no
x-f5xc-side-effects
หัวข้อที่มีชื่อว่า “x-f5xc-side-effects”- Applied at: operation
- Purpose: แสดงรายการผลข้างเคียงที่สังเกตได้จาก operation (restart, reconfigure เป็นต้น)
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/utils/operation_metadata_enricher.py
- Driven by config: config/operation_metadata.yaml
- Example:
"x-f5xc-side-effects": ["invalidates-cache"] - Pass-through from upstream: no
x-f5xc-discovered-response-time
หัวข้อที่มีชื่อว่า “x-f5xc-discovered-response-time”- Applied at: operation
- Purpose: เวลาตอบสนองที่วัดได้จริงสำหรับ operation นี้ระหว่าง discovery
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/discovery_enricher.py
- Driven by config: config/discovery_enrichment.yaml
- Example:
"x-f5xc-discovered-response-time": {"p50_ms": 40, "p95_ms": 120} - Pass-through from upstream: no
x-f5xc-discovered-rate-limits
หัวข้อที่มีชื่อว่า “x-f5xc-discovered-rate-limits”- Applied at: operation
- Purpose: headers / พฤติกรรมการจำกัดอัตราที่สังเกตได้จาก live API
- Consumers: multiple
- Value type: object
- Value schema:
{"type": "object"} - Injected by: scripts/utils/discovery_enricher.py
- Driven by config: config/discovery_enrichment.yaml
- Example:
"x-f5xc-discovered-rate-limits": {"limit": 100, "window_s": 60} - Pass-through from upstream: no
x-f5xc-discovered-error-catalog
หัวข้อที่มีชื่อว่า “x-f5xc-discovered-error-catalog”- Applied at: operation
- Purpose: แคตตาล็อกของการตอบสนองข้อผิดพลาดที่สังเกตได้ระหว่าง live discovery พร้อม payload ตัวอย่าง
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "object"}} - Injected by: scripts/utils/discovery_enricher.py
- Driven by config: config/discovery_enrichment.yaml
- Example:
"x-f5xc-discovered-error-catalog": [{"status": 400, "reason": "bad_request"}] - Pass-through from upstream: no
ฉีดเข้ามา — ระดับ index (domain metadata)
หัวข้อที่มีชื่อว่า “ฉีดเข้ามา — ระดับ index (domain metadata)”x-f5xc-category
หัวข้อที่มีชื่อว่า “x-f5xc-category”- Applied at: info
- Purpose: หมวดหมู่การจัดกลุ่มระดับบนสุดสำหรับ CLI / UI / docs / Terraform ของโดเมน
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-category": "networking" - Pass-through from upstream: no
x-f5xc-primary-resources
หัวข้อที่มีชื่อว่า “x-f5xc-primary-resources”- Applied at: info
- Purpose: รายการประเภททรัพยากรหลักที่กำหนดโดเมน
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-primary-resources": ["http_loadbalancer"] - Pass-through from upstream: no
x-f5xc-critical-resources
หัวข้อที่มีชื่อว่า “x-f5xc-critical-resources”- Applied at: info
- Purpose: ทรัพยากรที่ต้องการความระมัดระวังเป็นพิเศษ (สำคัญต่อ production)
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/merge_specs.py
- Driven by config: config/critical_resources.yaml
- Example:
"x-f5xc-critical-resources": ["tls_certificate"] - Pass-through from upstream: no
x-f5xc-description-short
หัวข้อที่มีชื่อว่า “x-f5xc-description-short”- Applied at: info
- Purpose: คำอธิบายโดเมนสั้น (~60 ตัวอักษร) ใช้ได้ในระดับ property ด้วยสำหรับคำอธิบายยาว
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/property_description_short_enricher.py
- Driven by config: config/property_description_short.yaml
- Example:
"x-f5xc-description-short": "Layer-7 HTTPS load balancing." - Pass-through from upstream: no
x-f5xc-description-medium
หัวข้อที่มีชื่อว่า “x-f5xc-description-medium”- Applied at: info
- Purpose: คำอธิบายโดเมนขนาดกลาง (~150 ตัวอักษร) ใช้ได้ในระดับ property ด้วย
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/property_description_short_enricher.py
- Driven by config: config/property_description_short.yaml
- Example:
"x-f5xc-description-medium": "HTTP/HTTPS load balancer with advanced routing, WAF, and TLS." - Pass-through from upstream: no
x-f5xc-description-long
หัวข้อที่มีชื่อว่า “x-f5xc-description-long”- Applied at: info
- Purpose: คำอธิบายโดเมนยาว (~500 ตัวอักษร)
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/utils/description_enricher.py
- Driven by config: config/domain_descriptions.yaml
- Example:
"x-f5xc-description-long": "Full paragraph describing the domain..." - Pass-through from upstream: no
x-f5xc-complexity
หัวข้อที่มีชื่อว่า “x-f5xc-complexity”- Applied at: info
- Purpose: ระดับความซับซ้อนสัมพัทธ์สำหรับการเขียน configurations ในโดเมนนี้
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string", "enum": ["low", "medium", "high"]} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-complexity": "medium" - Pass-through from upstream: no
x-f5xc-requires-tier
หัวข้อที่มีชื่อว่า “x-f5xc-requires-tier”- Applied at: info
- Purpose: ระดับการสมัครสมาชิก F5 XC ขั้นต่ำที่จำเป็น
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-requires-tier": "enterprise" - Pass-through from upstream: no
x-f5xc-is-preview
หัวข้อที่มีชื่อว่า “x-f5xc-is-preview”- Applied at: info
- Purpose: ทำเครื่องหมายโดเมนว่าเป็นฟีเจอร์ preview / beta
- Consumers: multiple
- Value type: boolean
- Value schema:
{"type": "boolean"} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-is-preview": false - Pass-through from upstream: no
x-f5xc-use-cases
หัวข้อที่มีชื่อว่า “x-f5xc-use-cases”- Applied at: info
- Purpose: กรณีการใช้งานที่มีชื่อซึ่งโดเมนนี้รองรับ
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-use-cases": ["tls-termination", "waf"] - Pass-through from upstream: no
x-f5xc-icon
หัวข้อที่มีชื่อว่า “x-f5xc-icon”- Applied at: info
- Purpose: ตัวระบุไอคอนที่ใช้เมื่อแสดงโดเมนนี้ใน UI
- Consumers: Web UI
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-icon": "f5xc:load-balancer" - Pass-through from upstream: no
x-f5xc-logo-svg
หัวข้อที่มีชื่อว่า “x-f5xc-logo-svg”- Applied at: info
- Purpose: SVG แบบ inline (หรือ path) สำหรับโลโก้แบรนด์ที่แทนโดเมน
- Consumers: Web UI
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-logo-svg": "<svg>...</svg>" - Pass-through from upstream: no
x-f5xc-related-domains
หัวข้อที่มีชื่อว่า “x-f5xc-related-domains”- Applied at: info
- Purpose: ลิงก์ข้ามไปยังโดเมนอื่นที่มักใช้ร่วมกับโดเมนนี้
- Consumers: multiple
- Value type: array
- Value schema:
{"type": "array", "items": {"type": "string"}} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-related-domains": ["origin_pool", "tls_certificate"] - Pass-through from upstream: no
x-f5xc-doc-section
หัวข้อที่มีชื่อว่า “x-f5xc-doc-section”- Applied at: info
- Purpose: slug ของส่วนเอกสาร / การจัดกลุ่มการนำทางสำหรับเอกสารที่แสดงผล
- Consumers: multiple
- Value type: string
- Value schema:
{"type": "string"} - Injected by: scripts/merge_specs.py
- Driven by config: config/domain_patterns.yaml
- Example:
"x-f5xc-doc-section": "load-balancing" - Pass-through from upstream: no
ส่งผ่านจาก upstream
หัวข้อที่มีชื่อว่า “ส่งผ่านจาก upstream”x-ves-proto-package
หัวข้อที่มีชื่อว่า “x-ves-proto-package”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example:
"x-ves-proto-package": "ves.io.schema.virtual_host" - Pass-through from upstream: yes
x-ves-proto-file
หัวข้อที่มีชื่อว่า “x-ves-proto-file”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example:
"x-ves-proto-file": "ves.io/schema/virtual_host/types.proto" - Pass-through from upstream: yes
x-ves-proto-message
หัวข้อที่มีชื่อว่า “x-ves-proto-message”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example:
"x-ves-proto-message": "ves.io.schema.virtual_host.CreateSpecType" - Pass-through from upstream: yes
x-ves-proto-service
หัวข้อที่มีชื่อว่า “x-ves-proto-service”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example:
"x-ves-proto-service": "ves.io.schema.virtual_host.API" - Pass-through from upstream: yes
x-ves-proto-rpc
หัวข้อที่มีชื่อว่า “x-ves-proto-rpc”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example:
"x-ves-proto-rpc": "ves.io.schema.api_sec.api_crawler.API.Create" - Pass-through from upstream: yes
x-displayname
หัวข้อที่มีชื่อว่า “x-displayname”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example:
"x-displayname": "Namespace" - Pass-through from upstream: yes
x-ves-oneof
หัวข้อที่มีชื่อว่า “x-ves-oneof”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example: ดูเอกสาร F5 upstream
- Pass-through from upstream: yes
x-ves-default
หัวข้อที่มีชื่อว่า “x-ves-default”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example: ดูเอกสาร F5 upstream
- Pass-through from upstream: yes
x-ves-required
หัวข้อที่มีชื่อว่า “x-ves-required”- Applied at: upstream
- Purpose: เก็บรักษาไว้โดยไม่เปลี่ยนแปลงจากสเปค F5 upstream
- Consumers: N/A
- Value type: varies
- Value schema: N/A
- Injected by: upstream
- Driven by config: upstream
- Example: ดูเอกสาร F5 upstream
- Pass-through from upstream: yes
x-f5xc-wire-name
หัวข้อที่มีชื่อว่า “x-f5xc-wire-name”- Applied at: schema property
- Purpose: คีย์ property ต้นทางดั้งเดิมที่ต้องส่งไปในคำขอ buffer zone จะเปลี่ยนชื่อ property ที่ F5 สะกดผิด และบันทึกคีย์ดั้งเดิมไว้ที่นี่ เนื่องจากเซิร์ฟเวอร์ F5 ยอมรับเฉพาะการสะกดดั้งเดิมเท่านั้น
- Consumers: Terraform
- Value type: string
- Value schema:
{"type": "string"} - Injected by: upstream (f5-sales-demo/api-specs)
- Driven by config: upstream
- Example:
"blocked_service": {"x-f5xc-wire-name": "blocked_sevice"} - Pass-through from upstream: yes