resources

Documentation

Index

• func AppendResourceData(newResources map[string]Resource)
• func GenerateResourceMetadataFromYaml(yamlTxt string) (map[string]Resource, error)
• func GenerateUrl(urlInfo *CrudEntityInfo, args []string) (string, error)
• func GenerateUrlViaIdableAttributes(urlInfo *CrudEntityInfo, args []id.IdableAttributes) (string, error)
• func GetNumberOfVariablesNeeded(url string) (int, error)
• func GetPluralResourceNames() []string
• func GetPluralResources() map[string]Resource
• func GetSingularResourceNames() []string
• func GetTypesOfVariablesNeeded(url string) ([]string, error)
• type CrudEntityAttribute
• type CrudEntityInfo
• type Resource
  • func GetResourceByName(name string) (Resource, bool)

Functions

func AppendResourceData

func AppendResourceData(newResources map[string]Resource)

func GenerateResourceMetadataFromYaml

func GenerateResourceMetadataFromYaml(yamlTxt string) (map[string]Resource, error)

func GenerateUrl

func GenerateUrl(urlInfo *CrudEntityInfo, args []string) (string, error)

func GenerateUrlViaIdableAttributes

func GenerateUrlViaIdableAttributes(urlInfo *CrudEntityInfo, args []id.IdableAttributes) (string, error)

func GetNumberOfVariablesNeeded

func GetNumberOfVariablesNeeded(url string) (int, error)

func GetPluralResourceNames

func GetPluralResourceNames() []string

func GetPluralResources

func GetPluralResources() map[string]Resource

func GetSingularResourceNames

func GetSingularResourceNames() []string

func GetTypesOfVariablesNeeded

func GetTypesOfVariablesNeeded(url string) ([]string, error)

Types

type CrudEntityAttribute

type CrudEntityAttribute struct {
	// The name of the attribute
	Key string

	// The type of the attribute
	Type           string `yaml:"type"`
	AutoFill       string `yaml:"autofill"`
	AliasAttribute string `yaml:"alias_attribute"`
}

type CrudEntityInfo

type CrudEntityInfo struct {

	// A link to the docs specific for the Crud operation in EPCC.
	Docs string `yaml:"docs"`

	// The Url we should use when invoking this method.
	Url string `yaml:"url"`

	// Content type to send
	ContentType string `yaml:"content-type"`

	// A list of valid query parameters
	QueryParameters string `yaml:"query"`

	// Minimum resources so we don't keep trying to delete in
	MinResources int `yaml:"min"`

	// Override the attribute we use in the URL for a specific key
	ParentResourceValueOverrides map[string]string `yaml:"parent_resource_value_overrides"`
}

type Resource

type Resource struct {
	// The type as far as the EPCC CLI is concerned.
	Type string

	// A link to the generic documentation page about a type in the EPCC API
	Docs string `yaml:"docs"`

	// The type that should be used in the JSON API.
	JsonApiType string `yaml:"json-api-type"`

	// Alterative types used for aliases
	AlternateJsonApiTypesForAliases []string `yaml:"alternate-json-type-for-aliases"`

	// Some resources (e.g., PCM, accelerator svc, bury most attributes under the attributes key). This is considered "compliant", other services just bury attributes under data, this is "legacy.
	JsonApiFormat string `yaml:"json-api-format"`

	// Information about how to get a collection
	GetCollectionInfo *CrudEntityInfo `yaml:"get-collection"`

	// Information about how to get a single object.
	GetEntityInfo *CrudEntityInfo `yaml:"get-entity"`

	// Information about how to create an entity.
	CreateEntityInfo *CrudEntityInfo `yaml:"create-entity"`

	// Information about how to update an entity.
	UpdateEntityInfo *CrudEntityInfo `yaml:"update-entity"`

	// Information about how to delete an entity.
	DeleteEntityInfo *CrudEntityInfo `yaml:"delete-entity"`

	Attributes map[string]*CrudEntityAttribute `yaml:"attributes"`

	// If true, don't wrap json in a data tag
	NoWrapping bool `yaml:"no-wrapping"`

	// The singular name version of the resource.
	SingularName string `yaml:"singular-name"`

	PluralName string

	// Use this value to silence warnings about a resource not supporting resets.
	// This should only be used for cases where we manually fix things, or where
	// a store reset would clear a resource another way (e.g., the resource represents a projection).
	SuppressResetWarning bool `yaml:"suppress-reset-warning"`
}

func GetResourceByName

func GetResourceByName(name string) (Resource, bool)