Extension Fields
Extension fields
allow flexible feature expansion while maintaining script compatibility. All extension fields are identified by thex-xc
prefix, ensuring system upgrades do not break existing script structures.
Core Rules
- Prefix Specification: All extension fields must start with
x-xc-
- Backward Compatibility: Extension fields must not affect existing script functionality
- Free Definition: Supports any value type (string/number/object/array, etc.)
- Flexible Placement: Can be added at any level within the script
Configuration Example
yaml
server:
url: "http://{env}-sample.angusmock.cloud:660"
variables:
env:
allowableValues: ["beta", "prod"]
defaultValue: beta
# Extension field example
x-xc-serverSource: CURRENT_REQUEST
x-xc-id: 201982800725803152
Notes
- Case Sensitivity:
x-xc-id
≠x-xc-ID
- Consistent Value Types: The same field should maintain the same data type across different scripts
- Documentation: Maintain internal team documentation for extension field descriptions
💡 Extension fields are not parsed by core system functionality and are primarily used for storing metadata or passing custom parameters.