Documentation
¶
Overview ¶
Package schemamd provides a function to render a Markdown formatted Schema definition.
Index ¶
- func RenderAction(schema *component.PipelinePluginActionSchema, w io.Writer) error
- func RenderPlugin(schema *schema.PluginSchema, w io.Writer) error
- func WriteAttributeDescription(w io.Writer, att *component.SchemaAttribute, includeRW bool) error
- func WriteBlockTypeDescription(w io.Writer, block *component.SchemaBlockSpec) error
- func WriteType(w io.Writer, ty cty.Type) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderAction ¶
func RenderAction(schema *component.PipelinePluginActionSchema, w io.Writer) error
RenderAction renders the markdown for an action schema.
func RenderPlugin ¶
func RenderPlugin(schema *schema.PluginSchema, w io.Writer) error
RenderPlugin writes a Markdown formatted Schema definition to the specified writer. A Schema contains a Version and the root Block, for example:
func WriteAttributeDescription ¶
WriteAttributeDescription writes the description of an attribute
func WriteBlockTypeDescription ¶
func WriteBlockTypeDescription(w io.Writer, block *component.SchemaBlockSpec) error
WriteBlockTypeDescription writes the description of a block spec field
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.