Add an optional input/output json schema for handlers (#499)

Author: igalshilman

packages/restate-sdk/src/types/components.ts

@@ -64,11 +64,13 @@ export class ServiceComponent implements Component {
             required: false,
             contentType:
               serviceHandler.handlerWrapper.accept ?? "application/json",
+            jsonSchema: serviceHandler.handlerWrapper.inputSchema,
           },
           output: {
             setContentTypeIfEmpty: false,
             contentType:
               serviceHandler.handlerWrapper.contentType ?? "application/json",
+            jsonSchema: serviceHandler.handlerWrapper.outputSchema,
           },
           documentation: serviceHandler.handlerWrapper.description,
           metadata: serviceHandler.handlerWrapper.metadata,
@@ -151,10 +153,12 @@ export class VirtualObjectComponent implements Component {
           input: {
             required: false,
             contentType: opts.accept ?? "application/json",
+            jsonSchema: opts.inputSchema,
           },
           output: {
             setContentTypeIfEmpty: false,
             contentType: opts.contentType ?? "application/json",
+            jsonSchema: opts.outputSchema,
           },
           ty:
             opts.kind === HandlerKind.EXCLUSIVE
@@ -235,10 +239,12 @@ export class WorkflowComponent implements Component {
           input: {
             required: false,
             contentType: handler.accept ?? "application/json",
+            jsonSchema: handler.inputSchema,
           },
           output: {
             setContentTypeIfEmpty: false,
             contentType: handler.contentType ?? "application/json",
+            jsonSchema: handler.outputSchema,
           },
           ty:
             handler.kind === HandlerKind.WORKFLOW

packages/restate-sdk/src/types/rpc.ts

@@ -284,6 +284,18 @@ export type ServiceHandlerOpts = {
    * Additional metadata for the handler.
    */
   metadata?: Record<string, string>;
+
+  /**
+   * An optional JSON schema definition for the input parameter.
+   * Please note that this is not enforced,  but only used as a documentation hint.
+   */
+  inputSchema?: object;
+
+  /**
+   * An optional JSON schema definition for the input parameter.
+   * Please note that this is not enforced,  but only used as a documentation hint.
+   */
+  outputSchema?: object;
 };
 
 export type ObjectHandlerOpts = {
@@ -325,6 +337,18 @@ export type ObjectHandlerOpts = {
    * Additional metadata for the handler.
    */
   metadata?: Record<string, string>;
+
+  /**
+   * An optional JSON schema definition for the input parameter.
+   * Please note that this is not enforced,  but only used as a documentation hint.
+   */
+  inputSchema?: object;
+
+  /**
+   * An optional JSON schema definition for the input parameter.
+   * Please note that this is not enforced,  but only used as a documentation hint.
+   */
+  outputSchema?: object;
 };
 
 export type WorkflowHandlerOpts = {
@@ -366,6 +390,18 @@ export type WorkflowHandlerOpts = {
    * Additional metadata for the handler.
    */
   metadata?: Record<string, string>;
+
+  /**
+   * An optional JSON schema definition for the input parameter.
+   * Please note that this is not enforced,  but only used as a documentation hint.
+   */
+  inputSchema?: object;
+
+  /**
+   * An optional JSON schema definition for the input parameter.
+   * Please note that this is not enforced,  but only used as a documentation hint.
+   */
+  outputSchema?: object;
 };
 
 const HANDLER_SYMBOL = Symbol("Handler");
@@ -393,7 +429,9 @@ export class HandlerWrapper {
       outputSerde,
       opts?.accept,
       opts?.description,
-      opts?.metadata
+      opts?.metadata,
+      opts?.inputSchema,
+      opts?.outputSchema
     );
   }
 
@@ -412,7 +450,9 @@ export class HandlerWrapper {
     public readonly outputSerde: Serde<unknown>,
     accept?: string,
     public readonly description?: string,
-    public readonly metadata?: Record<string, string>
+    public readonly metadata?: Record<string, string>,
+    public readonly inputSchema?: object,
+    public readonly outputSchema?: object
   ) {
     this.accept = accept ? accept : inputSerde.contentType;
     this.contentType = outputSerde.contentType;