Functions Payload Structure discussion

[mahatoankitkumar]

Payload Structure Versioning Plan

1. New Payload Structure
   v1.0 Payload Structures

event : {
            version:
            validate_value: {

             }
            value_compute:
            validate_context:
            validate_change_reason:
}





// validate_value
{
    version: "1.0",
    payload: {
        key: "string",
        value: any,
        type: "string",
        environment: {}
   }
}

// value_compute
{
    version: "1.0",
    name: "string",
    prefix: "string",
    type: "string",
    environment: {}
}

// validate_context
{
    version: "1.0",
    environment: {}
}

// validate_change_reason
{
    version: "1.0",
    change_reason: "string"
}

Future v2.0 (Example)

// Same structure but with additional fields
{
    version: "2.0",
    key: "string",
    value: any,
    valueType: "string",      // renamed from 'type'
    environment: {},
    metadata: {               // new field
        timestamp: "ISO-8601",
        source: "string"
    }
}

2. User Function Signature Changes
   Current (multiple parameters)

async function validate_value(key, value, type, environment) {
    return true;
}

New (single payload object)

async function validate_value(payload) {
    const { version, key, value, type, environment } = payload;
    return true;
}

3. Required Code Changes

• Database

Add payload_version column to functions table
Default value: "1.0"

• Rust Code

Modify FunctionType::get_fn_signature() to accept version parameter
Store signatures for all versions and provide as per the version mentioned in the database
Support multiple versions in match statements for signatures

• API

Add payload_version field to function create/update endpoints (optional, defaults to latest)

4. Migration

All existing functions automatically get payload_version = "1.0"
Payload format remains identical (backward compatible)

5. Benefits

Can add new fields in v2.0 without breaking v1.0 users
Users migrate when ready
Multiple versions coexist