Documentation
¶
Overview ¶
Package jsonkit is used to interpret AppConfig/JSON configuration units.
Index ¶
- Constants
- type JSONResourceProviderType
- func (*JSONResourceProviderType) ContextPath(contextField string) string
- func (*JSONResourceProviderType) DataType() api.DataType
- func (*JSONResourceProviderType) DefaultResourceCategory() api.ResourceCategory
- func (rp *JSONResourceProviderType) DeleteResourceID(doc *gaby.YamlDoc) errordeprecated
- func (rp *JSONResourceProviderType) DeleteResourceMergeID(doc *gaby.YamlDoc) error
- func (*JSONResourceProviderType) GetToolchainType() workerapi.ToolchainType
- func (*JSONResourceProviderType) IsMapKeyPath(_ api.ResourceType, _ string) bool
- func (*JSONResourceProviderType) MergeKeyForPath(_ api.ResourceType, _ string) (string, bool)
- func (*JSONResourceProviderType) NameSeparator() string
- func (*JSONResourceProviderType) NativeToYAML(data []byte) ([]byte, error)
- func (*JSONResourceProviderType) NormalizeName(name string) string
- func (*JSONResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName
- func (rp *JSONResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, ...)
- func (*JSONResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)
- func (rp *JSONResourceProviderType) ResourceIDGetter(doc *gaby.YamlDoc) (string, error)deprecated
- func (rp *JSONResourceProviderType) ResourceMergeIDGetter(doc *gaby.YamlDoc) (string, error)
- func (*JSONResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
- func (rp *JSONResourceProviderType) ResourceNameStableCoreGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
- func (*JSONResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)
- func (*JSONResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool
- func (*JSONResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath
- func (rp *JSONResourceProviderType) SetResourceID(doc *gaby.YamlDoc, id string) errordeprecated
- func (rp *JSONResourceProviderType) SetResourceMergeID(doc *gaby.YamlDoc, id string) error
- func (*JSONResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error
- func (*JSONResourceProviderType) TypeDescription() string
- func (*JSONResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)
Constants ¶
const ( ResourceTypeNoSchema = api.ResourceType("NoSchema") ResourceNameNoName = api.ResourceName("NoName") ConfigSchemaPath = api.ResolvedPath("configHub.configSchema") ConfigNamePath = api.ResolvedPath("configHub.configName") )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type JSONResourceProviderType ¶
type JSONResourceProviderType struct {
yamlkit.ResourceProviderRegistry
}
func NewJSONResourceProvider ¶
func NewJSONResourceProvider() *JSONResourceProviderType
NewJSONResourceProvider creates a new JSONResourceProviderType with its own path registry.
func (*JSONResourceProviderType) ContextPath ¶
func (*JSONResourceProviderType) ContextPath(contextField string) string
func (*JSONResourceProviderType) DataType ¶
func (*JSONResourceProviderType) DataType() api.DataType
func (*JSONResourceProviderType) DefaultResourceCategory ¶
func (*JSONResourceProviderType) DefaultResourceCategory() api.ResourceCategory
DefaultResourceCategory returns the default resource category to assume, which is AppConfig in this case.
func (*JSONResourceProviderType) DeleteResourceID
deprecated
added in
v0.1.14
func (rp *JSONResourceProviderType) DeleteResourceID(doc *gaby.YamlDoc) error
Deprecated: Use DeleteResourceMergeID instead.
func (*JSONResourceProviderType) DeleteResourceMergeID ¶ added in v0.1.15
func (rp *JSONResourceProviderType) DeleteResourceMergeID(doc *gaby.YamlDoc) error
func (*JSONResourceProviderType) GetToolchainType ¶
func (*JSONResourceProviderType) GetToolchainType() workerapi.ToolchainType
func (*JSONResourceProviderType) IsMapKeyPath ¶ added in v0.1.15
func (*JSONResourceProviderType) IsMapKeyPath(_ api.ResourceType, _ string) bool
func (*JSONResourceProviderType) MergeKeyForPath ¶
func (*JSONResourceProviderType) MergeKeyForPath(_ api.ResourceType, _ string) (string, bool)
func (*JSONResourceProviderType) NameSeparator ¶
func (*JSONResourceProviderType) NameSeparator() string
func (*JSONResourceProviderType) NativeToYAML ¶
func (*JSONResourceProviderType) NativeToYAML(data []byte) ([]byte, error)
NativeToYAML converts JSON data to YAML format.
func (*JSONResourceProviderType) NormalizeName ¶
func (*JSONResourceProviderType) NormalizeName(name string) string
func (*JSONResourceProviderType) RemoveScopeFromResourceName ¶
func (*JSONResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName
func (*JSONResourceProviderType) ResourceAndCategoryTypeMaps ¶
func (rp *JSONResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, categoryTypeMap yamlkit.ResourceCategoryTypeToNamesMap, err error)
ResourceAndCategoryTypeMaps returns maps of all resources in the provided list of parsed YAML documents, from from names to categories+types and categories+types to names.
func (*JSONResourceProviderType) ResourceCategoryGetter ¶
func (*JSONResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)
ResourceCategoryGetter just returns ResourceCategoryAppConfig for JSON documents.
func (*JSONResourceProviderType) ResourceIDGetter
deprecated
func (rp *JSONResourceProviderType) ResourceIDGetter(doc *gaby.YamlDoc) (string, error)
Deprecated: Use ResourceMergeIDGetter instead.
func (*JSONResourceProviderType) ResourceMergeIDGetter ¶ added in v0.1.15
func (rp *JSONResourceProviderType) ResourceMergeIDGetter(doc *gaby.YamlDoc) (string, error)
func (*JSONResourceProviderType) ResourceNameGetter ¶
func (*JSONResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
ResourceNameGetter extracts the property configHub.configName, and returns NoName if not present.
func (*JSONResourceProviderType) ResourceNameStableCoreGetter ¶ added in v0.1.15
func (rp *JSONResourceProviderType) ResourceNameStableCoreGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
func (*JSONResourceProviderType) ResourceTypeGetter ¶
func (*JSONResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)
ResourceTypeGetter extracts the property configHub.configSchema, and returns NoSchema if not present.
func (*JSONResourceProviderType) ResourceTypesAreSimilar ¶
func (*JSONResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool
func (*JSONResourceProviderType) ScopelessResourceNamePath ¶
func (*JSONResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath
func (*JSONResourceProviderType) SetResourceID
deprecated
func (rp *JSONResourceProviderType) SetResourceID(doc *gaby.YamlDoc, id string) error
Deprecated: Use SetResourceMergeID instead.
func (*JSONResourceProviderType) SetResourceMergeID ¶ added in v0.1.15
func (rp *JSONResourceProviderType) SetResourceMergeID(doc *gaby.YamlDoc, id string) error
func (*JSONResourceProviderType) SetResourceName ¶
func (*JSONResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error
func (*JSONResourceProviderType) TypeDescription ¶
func (*JSONResourceProviderType) TypeDescription() string
func (*JSONResourceProviderType) YAMLToNative ¶
func (*JSONResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)
YAMLToNative converts YAML data to JSON format.