Skip to content

Extension Fields

Extension fields allow flexible feature expansion while maintaining script compatibility. All extension fields are identified by the x-xc prefix, ensuring system upgrades do not break existing script structures.

Core Rules

  1. Prefix Specification: All extension fields must start with x-xc-
  2. Backward Compatibility: Extension fields must not affect existing script functionality
  3. Free Definition: Supports any value type (string/number/object/array, etc.)
  4. 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

  1. Case Sensitivity: x-xc-idx-xc-ID
  2. Consistent Value Types: The same field should maintain the same data type across different scripts
  3. 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.

Released under the GPL-3.0 License.