schemamd

package
v0.24.0 Latest Latest
Warning

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

Go to latest
Published: Oct 13, 2025 License: MPL-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Render

func Render(schema *tfjson.Schema, w io.Writer) error

Render writes a Markdown formatted Schema definition to the specified writer. A Schema contains a Version and the root Block, for example:

"aws_accessanalyzer_analyzer": {
  "block": {
  },
	 "version": 0
},

func RenderAction added in v0.23.0

func RenderAction(schema *tfjson.ActionSchema, w io.Writer) error

RenderAction is a variant of Render for action schemas. Action schemas share the same config block as resource schemas, with the addition of other schema data based on the type of action it is.

func RenderIdentitySchema added in v0.22.0

func RenderIdentitySchema(identitySchema *tfjson.IdentitySchema, w io.Writer) error

func WriteAttributeDescription

func WriteAttributeDescription(w io.Writer, att *tfjson.SchemaAttribute, includeRW bool) error

func WriteBlockTypeDescription

func WriteBlockTypeDescription(w io.Writer, block *tfjson.SchemaBlockType) error

func WriteNestedAttributeTypeDescription

func WriteNestedAttributeTypeDescription(w io.Writer, att *tfjson.SchemaAttribute, includeRW bool) error

func WriteType

func WriteType(w io.Writer, ty cty.Type) error

Types

This section is empty.

Jump to

Keyboard shortcuts

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