jsonschema

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package jsonschema renders schema.Schema values to plain JSON Schema compatible json.RawMessage.

Unlike render/openapi and render/asyncapi, this package produces stand-alone JSON Schema objects without any OpenAPI or AsyncAPI envelope. The output is suitable for use as MCP tool input/output schemas or any context that requires raw JSON Schema rather than a full API document.

Usage

Call Schema with any schema.Schema value to obtain the JSON Schema bytes. Returns nil for a zero-value schema (no type, no properties):

raw, err := jsonschema.Schema(myCodec.Schema)
// raw is json.RawMessage ready to pass to an MCP tool's inputSchema field.

This package is used internally by api/mcp to convert codec schemas to the MCP tool manifest format. It wraps render/internal/schemarender.SchemaObject and marshals the result to JSON.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Schema

func Schema(s schema.Schema) (json.RawMessage, error)

Schema renders s to a JSON Schema compatible json.RawMessage. Returns nil when s is the zero value — callers may omit the schema field.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL