smithy

package
v0.2.13 Latest Latest
Warning

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

Go to latest
Published: Oct 3, 2026 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package smithy generates a Smithy IDL 2.0 model from a resolved model.

docs/design/schema-backends.md has the mapping and the reasons for it. Three things are worth knowing before reading the output. Smithy names every collection, so a list or map a field holds is a shape the backend declares, named for what it holds (`LineItemList`, `StringLongMap`) and declared once however many fields use it. A newtype over a primitive or a collection is a named shape of its own. And a field that is not optional is `@required`, since Smithy members are optional by default.

Index

Constants

View Source
const Name = "smithy"

Name is what this backend is called, in a target block and as tdl-gen-smithy on PATH.

Variables

This section is empty.

Functions

This section is empty.

Types

type Backend

type Backend struct{}

Backend implements plugin.Backend.

func (Backend) Describe

func (Backend) Describe() plugin.Description

func (Backend) Generate

func (Backend) Generate(_ context.Context, req *plugin.Request) (*plugin.Response, error)

Generate returns one .smithy file holding every declaration the model owns.

Jump to

Keyboard shortcuts

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