docsgen

Documentation

Index

• type Resource
  • func (r *Resource) GenerateResourceMarkdown(wr io.Writer) error
• type ResourceDocs

Types

type Resource

type Resource struct {
	ProviderKey  string
	ProviderName string

	ResourceKey    string
	ResourceSlug   string
	ResourceSchema *schema.Resource
}

func (*Resource) GenerateResourceMarkdown

func (r *Resource) GenerateResourceMarkdown(wr io.Writer) error

type ResourceDocs

type ResourceDocs struct {
	ProviderKey  string
	ProviderName string
	ResourceKey  string
	ResourceSlug string

	Fields       map[string]*schema.Schema
	NestedFields map[string]map[string]*schema.Schema

	MarkdownHeaderFunc func(s string) string
}