Documentation
¶
Overview ¶
Package sdkdocs defines a Docs provider which can be used to interact with structured documentation generated by Nobl9 SDK.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Docs ¶
type Docs struct {
// contains filtered or unexported fields
}
func (Docs) GetDeprecatedPaths ¶
GetDeprecatedPaths returns a list of deprecated paths for the given kind.
func (Docs) GetProperty ¶
func (s Docs) GetProperty(kind manifest.Kind, path string) *PropertyDoc
GetProperty returns a PropertyDoc matching provided kind and path. If the property was not found it returns nil.
type PropertyDoc ¶
type PropertyDoc struct {
Path string `json:"path"`
Type string `json:"type"`
Package string `json:"package,omitempty"`
Doc string `yaml:"doc,omitempty"`
IsDeprecated bool `json:"isDeprecated,omitempty"`
IsOptional bool `json:"isOptional,omitempty"`
IsSecret bool `json:"isSecret,omitempty"`
Examples []string `json:"examples,omitempty"`
Values []string `json:"values,omitempty"`
Rules []RulePlan `json:"rules,omitempty"`
ChildrenPaths []string `json:"childrenPaths,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.