Minimal hello module for wippy.ai platform
This is a minimal example module for the wippy.ai platform that demonstrates basic module structure and functionality.
The module is defined in module_example.yaml
and follows the wippy.ai module specification:
version
: Module version (e.g., "1.0.0")namespace
: Module namespace (e.g., "localspace")
The module contains several types of entries:
Used to define requirements for the module:
- name: NAMESPACE
kind: ns.requirement
meta:
description: "Target namespace for module requirement"
targets:
- entry: ".meta.depends_on +="
kind: ns.requirement
- Specifies this is a namespace requirementtargets
- List of target configurationsentry
- The identifier of target entrypath
- The path where the requirement should be applied
Defines Lua functions that can be executed:
- name: hello_handler
kind: function.lua
source: file://hello_world.lua
method: handler
meta:
comment: "Lua function for hello_endpoint"
modules: [ http ]
pool:
size: 2
workers: 4
Defines HTTP endpoints that can be accessed:
- name: hello_endpoint
kind: http.endpoint
method: GET
meta:
comment: "HTTP endpoint which executes hello_handler"
path: "/local/hello"
func: hello_handler
The module uses the following field naming convention:
entry
- Used for target identifierspath
- Used for configuration paths
- Deploy the module to your wippy.ai environment
- The module will create a GET endpoint at
/local/hello
- The endpoint will execute the
hello_handler
function defined inhello_world.lua
module_example.yaml
- Module configurationhello_world.lua
- Lua function implementationREADME.md
- This documentation