contents

type ArgumentsSection SchemaAttributeSection

type AttributesSection SchemaAttributeSection

type CheckArgumentsSectionOptions struct {
	EnhancedRegionChecks  bool
	RegionAware           bool // The resource is Region-aware and has a top-level region argument.
	RequireSchemaOrdering bool
	ExpectedBylineTexts   []string
	AllowedHeadingTexts   []string
	AllowMissingByline    bool
}

type CheckAttributesSectionOptions struct {
	RequireSchemaOrdering bool
	RequireSection        SectionRequirement
}

type CheckExamplesSectionOptions struct {
	ExpectedCodeBlockLanguage string
}

type CheckImportSectionOptions struct {
	RequireSection SectionRequirement
}

type CheckOptions struct {
	ArgumentsSection  *CheckArgumentsSectionOptions
	AttributesSection *CheckAttributesSectionOptions
	ExamplesSection   *CheckExamplesSectionOptions
	TimeoutsSection   *CheckTimeoutsSectionOptions
	ImportSection     *CheckImportSectionOptions
	TitleSection      *CheckTitleSectionOptions
	SignatureSection  *CheckSignatureSectionOptions

	DisallowAttributesSection          bool
	AttributesSectionDisallowedMessage string
	DisallowImportSection              bool
	ImportSectionDisallowedMessage     string
}

type CheckSignatureSectionOptions struct {
	RequireSection      SectionRequirement
	AllowedHeadingTexts []string
	RequireCodeBlock    bool
}

type CheckTimeoutsSectionOptions struct {
	RequireSection SectionRequirement
}

type CheckTitleSectionOptions struct {
	AllowedPrefixes []string
}

type Document struct {
	CheckOptions *CheckOptions
	ProviderName string
	ResourceName string
	Sections     *Sections
	// contains filtered or unexported fields
}

type ExampleSection struct {
	// Children contains further nested sections below this section
	Children []*ExampleSection

	FencedCodeBlocks []*ast.FencedCodeBlock
	Heading          *ast.Heading
	Paragraphs       []*ast.Paragraph
}

type ImportSection struct {
	FencedCodeBlocks []*ast.FencedCodeBlock
	Heading          *ast.Heading
	Paragraphs       []*ast.Paragraph
}

type SchemaAttributeList struct {
	Items []*SchemaAttributeListItem
}

type SchemaAttributeListItem struct {
	Description string
	ForceNew    bool
	Name        string
	Optional    bool
	Required    bool
	Type        string
}

type SchemaAttributeListItemByName []*SchemaAttributeListItem

type SchemaAttributeSection struct {
	// Children contains further nested sections below this section
	Children []*SchemaAttributeSection

	// FencedCodeBlocks contains any found code blocks
	FencedCodeBlocks []*ast.FencedCodeBlock

	// Heading is the root/nested heading for the section
	Heading *ast.Heading

	// Lists is the groupings of per-attribute documentation
	//
	// Some sections may be split these based on Optional versus Required
	Lists []*ast.List

	// SchemaAttributeLists is the groupings of per-attribute documentation
	//
	// Some sections may be split these based on Optional versus Required
	SchemaAttributeLists []*SchemaAttributeList

	// Paragraphs is typically the byline(s) of per-attribute documentation
	//
	// Some sections may be split these based on Optional versus Required
	Paragraphs []*ast.Paragraph
}

type SectionRequirement int

type Sections struct {
	Attributes *AttributesSection
	Arguments  *ArgumentsSection
	Example    *ExampleSection
	Import     *ImportSection
	Timeouts   *TimeoutsSection
	Signature  *SignatureSection
	Title      *TitleSection
}

type SignatureSection struct {
	FencedCodeBlocks []*ast.FencedCodeBlock
	Heading          *ast.Heading
	Paragraphs       []*ast.Paragraph
}

type TimeoutsSection struct {
	FencedCodeBlocks []*ast.FencedCodeBlock
	Heading          *ast.Heading
	Lists            []*ast.List
	Paragraphs       []*ast.Paragraph
}

type TitleSection struct {
	FencedCodeBlocks []*ast.FencedCodeBlock
	Heading          *ast.Heading
	Paragraphs       []*ast.Paragraph
}