Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openapiterraformdocsgenerator

package

Go to main page

Versions in this module

v0

v0.31.1

Jul 20, 2020

v0.31.0

Jul 15, 2020

Changes in this version

type Property

+ IsParent bool

v0.30.1

Jul 6, 2020

Changes in this version

type DataSource

+ Description string

type ExampleUsage

+ Title string

+ type KnownIssue struct

+ Description string

+ Examples []ExampleUsage

+ Title string

type Resource

+ KnownIssues []KnownIssue

type TerraformProviderDocumentation

+ ProviderNotes []string

v0.30.0

Jul 1, 2020

Changes in this version

+ var ArgumentReferenceTmpl = ...

+ var AttributeReferenceTmpl = ...

+ var DataSourcesTmpl = fmt.Sprintf(..., AttributeReferenceTmpl)

+ var ProviderConfigurationTmpl = ...

+ var ProviderInstallationTmpl = ...

+ var ProviderResourcesTmpl = fmt.Sprintf(..., ArgumentReferenceTmpl, AttributeReferenceTmpl)

+ var SpecialTermsTmpl = ...

+ var TableOfContentsTmpl = ...

+ type ArgumentsReference struct

+ Notes []string

+ type AttributesReference struct

+ Description string

+ Notes []string

+ Properties []Property

+ type DataSource struct

+ Name string

+ OtherExample string

+ Properties []Property

+ type DataSources struct

+ DataSourceInstances []DataSource

+ DataSources []DataSource

+ ProviderName string

+ type ExampleUsage struct

+ Example string

+ type Property struct

+ ArrayItemsType string

+ Computed bool

+ Description string

+ IsOptionalComputed bool

+ IsSensitive bool

+ Name string

+ Required bool

+ Schema []Property

+ Type string

+ func (p Property) ContainsComputedSubProperties() bool

+ type ProviderConfiguration struct

+ ArgumentsReference ArgumentsReference

+ ConfigProperties []Property

+ ExampleUsage []ExampleUsage

+ ProviderName string

+ Regions []string

+ type ProviderInstallation struct

+ Example string

+ Other string

+ OtherCommand string

+ ProviderName string

+ type ProviderResources struct

+ ProviderName string

+ Resources []Resource

+ func (r ProviderResources) ContainsResourcesWithSecretProperties() bool

+ type Resource struct

+ ArgumentsReference ArgumentsReference

+ Description string

+ ExampleUsage []ExampleUsage

+ Name string

+ ParentProperties []string

+ Properties []Property

+ func (r Resource) BuildImportIDsExample() string

+ type TerraformProviderDocGenerator struct

+ ProviderName string

+ SpecAnalyser openapi.SpecAnalyser

+ func NewTerraformProviderDocGenerator(providerName, openAPIDocURL string) (TerraformProviderDocGenerator, error)

+ func (t TerraformProviderDocGenerator) GenerateDocumentation() (TerraformProviderDocumentation, error)

+ type TerraformProviderDocumentation struct

+ DataSources DataSources

+ ProviderConfiguration ProviderConfiguration

+ ProviderInstallation ProviderInstallation

+ ProviderName string

+ ProviderResources ProviderResources

+ ShowSpecialTermsDefinitions bool

+ func (t TerraformProviderDocumentation) RenderHTML(w io.Writer) error

Other modules containing this package

github.com/dikhan/terraform-provider-openapi/v2

github.com/dikhan/terraform-provider-openapi/v3