Documentation
¶
Index ¶
- func ProcessMarkdown(providerDir string) (map[string]*model.ResourceDoc, error)
- func ProcessSchema(providerPath, gitBranch string) (*schema.ProviderSchema, error)
- type TerraformObject
- func (b *TerraformObject) GetDocContent() string
- func (b *TerraformObject) GetGitHubIssueLink() string
- func (b *TerraformObject) GetModuleDocLink() string
- func (b *TerraformObject) GetModuleGitHubIssueLink() string
- func (b *TerraformObject) GetName() string
- func (b *TerraformObject) GetRaiseAVMGitHubIssueLink() string
- func (b *TerraformObject) GetRaiseGitHubIssueLink() string
- func (b *TerraformObject) GetResourceOrDataSourceDocLink() string
- func (b *TerraformObject) GetSnippet() string
- func (b *TerraformObject) IsDataSource() bool
- func (b *TerraformObject) IsModule() bool
- type TerraformObjects
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ProcessMarkdown ¶
func ProcessMarkdown(providerDir string) (map[string]*model.ResourceDoc, error)
ProcessMarkdown processes all markdown files in the given directory and returns structured output
func ProcessSchema ¶
func ProcessSchema(providerPath, gitBranch string) (*schema.ProviderSchema, error)
Types ¶
type TerraformObject ¶
type TerraformObject struct {
Name string `json:"name"`
Fields map[string]*schema.SchemaAttribute `json:"fields"`
ExampleHCL string `json:"example_hcl"`
Timeouts *model.Timeouts
Import model.Import
Details string `json:"details"` // Start from first h2 header (after description)
}
func (*TerraformObject) GetDocContent ¶
func (b *TerraformObject) GetDocContent() string
func (*TerraformObject) GetGitHubIssueLink ¶
func (b *TerraformObject) GetGitHubIssueLink() string
func (*TerraformObject) GetModuleDocLink ¶ added in v0.6.0
func (b *TerraformObject) GetModuleDocLink() string
func (*TerraformObject) GetModuleGitHubIssueLink ¶ added in v0.6.0
func (b *TerraformObject) GetModuleGitHubIssueLink() string
func (*TerraformObject) GetName ¶
func (b *TerraformObject) GetName() string
func (*TerraformObject) GetRaiseAVMGitHubIssueLink ¶ added in v0.6.0
func (b *TerraformObject) GetRaiseAVMGitHubIssueLink() string
func (*TerraformObject) GetRaiseGitHubIssueLink ¶
func (b *TerraformObject) GetRaiseGitHubIssueLink() string
func (*TerraformObject) GetResourceOrDataSourceDocLink ¶
func (b *TerraformObject) GetResourceOrDataSourceDocLink() string
func (*TerraformObject) GetSnippet ¶
func (b *TerraformObject) GetSnippet() string
func (*TerraformObject) IsDataSource ¶
func (b *TerraformObject) IsDataSource() bool
func (*TerraformObject) IsModule ¶ added in v0.6.0
func (b *TerraformObject) IsModule() bool
type TerraformObjects ¶
type TerraformObjects map[string]*TerraformObject
func CombineSchemaAndMarkdown ¶
func CombineSchemaAndMarkdown(providerSchema *schema.ProviderSchema, markdownDocs map[string]*model.ResourceDoc) (TerraformObjects, error)
CombineSchemaAndMarkdown merges markdown fields into the schema and returns the combined resources.
func LoadProcessedOutput ¶
func LoadProcessedOutput() (TerraformObjects, error)
func ProcessOutput ¶
func ProcessOutput(providerPath, gitBranch, outputDir string) (TerraformObjects, error)
ProcessOutput combines schema and markdown outputs and saves the result to a file
Click to show internal directories.
Click to hide internal directories.