Skip to main content

GetConfigSchemaFn

Type Alias GetConfigSchemaFn 

Source
pub type GetConfigSchemaFn = unsafe extern "C" fn(schema_ptr: *mut *mut u8, schema_len: *mut usize) -> i32;
Expand description

Function signature for getting plugin configuration schema

This function returns a JSON Schema describing the plugin’s configuration structure. It’s used by clients to:

  • Validate configuration before sending
  • Generate UI for configuration
  • Document configuration requirements

The schema should follow JSON Schema Draft 7 format.

§Parameters

  • schema_ptr: Output pointer for schema JSON string
  • schema_len: Output length of schema JSON string

§Returns

  • 0 on success
  • Non-zero if schema generation fails

The framework will call free_string to deallocate the schema string.