persistence

Documentation

Index

• type DeleteEntries
  • func (_ DeleteEntries) JSONSchema() *jsonschema.Schema
• type DeleteEntry
• type FileDefinition
• type FullFileDefinition

Types

type DeleteEntries

type DeleteEntries []DeleteEntry

func (DeleteEntries) JSONSchema

func (_ DeleteEntries) JSONSchema() *jsonschema.Schema

JSONSchema defines a custom schema definition for ReferenceSlice as it contains either Reference objects or strings when being parsed, but our schema generator can not resolve such a nested "one-of" relation correctly for slices

type DeleteEntry

type DeleteEntry struct {
	// Project the config was in - required for configs with generated IDs (e.g. Settings 2.0, Automations, Grail Buckets)
	Project string `` /* 218-byte string literal not displayed */
	// Type of the config to be deleted
	Type string `yaml:"type" json:"type" mapstructure:"type" jsonschema:"required,description=The type of config to be deleted."`
	// ConfigId is the monaco ID of the config to be deleted - required for configs with generated IDs (e.g. Settings 2.0, Automations, Grail Buckets)
	ConfigId string `` /* 215-byte string literal not displayed */
	// ConfigName is the name of the config to be deleted - required for configs deleted by name (classic Config API types)
	ConfigName string `` /* 192-byte string literal not displayed */

	// Scope is the parent scope of a config. This field must be set if a classic config is used, and the classic config requires the scope to be set.
	Scope string `` /* 177-byte string literal not displayed */
	// CustomValues holds special values that are not general enough to add as a field to a DeleteEntry but are still important for specific APIs
	CustomValues map[string]string `yaml:",inline" mapstructure:",remain"`
}

DeleteEntry is a full representation of a delete entry loaded from a YAML delete file ConfigId and ConfigName should be mutually exclusive (validated if using LoadEntriesToDelete)

type FileDefinition

type FileDefinition struct {
	// DeleteEntries loaded from a file are either legacy shorthand strings or full DeleteEntry values
	DeleteEntries []interface{} `yaml:"delete"`
}

FileDefinition represents a loaded YAML delete file consisting of a list of delete entries called 'delete' In this struct DeleteEntries may either be a legacy shorthand string or full DeleteEntry value. Use FullFileDefinition if you're always working with DeleteEntry values instead

type FullFileDefinition

type FullFileDefinition struct {
	// DeleteEntries defining which configurations should be deleted
	DeleteEntries DeleteEntries `yaml:"delete" json:"delete"`
}

FullFileDefinition represents a delete file consisting of a list of delete entries called 'delete' In this struct DeleteEntries are DeleteEntry values.