SocialluxSociallux
Toggle navigation menu
Docs navigationv

Primitive

verb.contract

BETA

Short name: contract

Version: 1.0.0

Returns a developer-facing contract for a verb: how to call it, the inputs it needs, the output shape, and an example invocation.

Back to primitive library

Inputs

KeyTypeRequiredDescription
verbIdobjectIdtrueVerb whose contract should be returned.

Outputs

KeyTypeRequiredDescription
contractobjectfalseResult of buildVerbContract - declaration, inputs, outputs, steps (when composed), and the resolved primitive for primitive verbs.
usageobjectfalseHow to invoke the verb over HTTP: { method, path, bodyShape, exampleRequest, exampleResponse }.
verbobjectfalseIdentity block: { id, name, description, type, owner, isPublic }.