Skip to content

chore: add json tags to mta_ext schema #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Haegi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: add json tags to mta_ext schema #234

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions mta/mta_ext_schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,41 @@ package mta
// EXT mta extension schema
type EXT struct {
// indicates MTA schema version, using semver.
SchemaVersion *string `yaml:"_schema-version"`
SchemaVersion *string `yaml:"_schema-version" json:"_schema-version"`
// A globally unique ID of this MTA extension. Unlimited string of unicode characters.
ID string `yaml:"ID"`
ID string `yaml:"ID" json:"ID"`
// A non-translatable description of this MTA extension. This is not a text for application users
Description string `yaml:"description,omitempty"`
Description string `yaml:"description,omitempty" json:"description,omitempty"`
// a globally unique ID of the MTA or the MTA extension which shall be extended by this descriptor
Extends string `yaml:"extends"`
Extends string `yaml:"extends" json:"extends"`
// Application version, using semantic versioning standard
Version string `yaml:"version,omitempty"`
Version string `yaml:"version,omitempty" json:"version,omitempty"`
// The provider of this extension descriptor
Provider string `yaml:"provider,omitempty"`
Provider string `yaml:"provider,omitempty" json:"provider,omitempty"`
// list of modules
Modules []*ModuleExt `yaml:"modules,omitempty"`
Modules []*ModuleExt `yaml:"modules,omitempty" json:"modules,omitempty"`
// Resource declarations. Resources can be anything required to run the application which is not provided by the application itself
Resources []*ResourceExt `yaml:"resources,omitempty"`
Resources []*ResourceExt `yaml:"resources,omitempty" json:"resources,omitempty"`
// Parameters can be used to steer the behavior of tools which interpret this descriptor
Parameters map[string]interface{} `yaml:"parameters,omitempty"`
Parameters map[string]interface{} `yaml:"parameters,omitempty" json:"parameters,omitempty"`
}

// ModuleExt - modules section in MTA extension
type ModuleExt struct {
// An MTA internal module name. Names need to be unique within the MTA scope
Name string
// Provided property values can be accessed by "~{<name-of-provides-section>/<provided-property-name>}". Such expressions can be part of an arbitrary string
Properties map[string]interface{} `yaml:"properties,omitempty"`
Properties map[string]interface{} `yaml:"properties,omitempty" json:"properties,omitempty"`
// THE 'includes' ELEMENT IS ONLY RELEVANT FOR DEVELOPMENT DESCRIPTORS (PRIO TO BUILD), NOT FOR DEPLOYMENT DESCRIPTORS!
Includes []Includes `yaml:"includes,omitempty"`
Includes []Includes `yaml:"includes,omitempty" json:"includes,omitempty"`
// list of names either matching a resource name or a name provided by another module within the same MTA
Requires []Requires `yaml:"requires,omitempty"`
Requires []Requires `yaml:"requires,omitempty" json:"requires,omitempty"`
// List of provided names (MTA internal)to which properties (= configuration data) can be attached
Provides []Provides `yaml:"provides,omitempty"`
Provides []Provides `yaml:"provides,omitempty" json:"provides,omitempty"`
// Parameters can be used to steer the behavior of tools which interpret this descriptor. Parameters are not made available to the module at runtime
Parameters map[string]interface{} `yaml:"parameters,omitempty"`
Parameters map[string]interface{} `yaml:"parameters,omitempty" json:"parameters,omitempty"`
// Build-parameters are specifically steering the behavior of build tools.
BuildParams map[string]interface{} `yaml:"build-parameters,omitempty"`
BuildParams map[string]interface{} `yaml:"build-parameters,omitempty" json:"build-parameters,omitempty"`
// Defined and executed at specific phases of module deployment.
Hooks []Hook `yaml:"hooks,omitempty" json:"hooks,omitempty"`
}
Expand All @@ -46,11 +46,11 @@ type ModuleExt struct {
type ResourceExt struct {
Name string
// A type of a resource. This type is interpreted by and must be known to the deployer. Resources can be untyped
Parameters map[string]interface{} `yaml:"parameters,omitempty"`
Parameters map[string]interface{} `yaml:"parameters,omitempty" json:"parameters,omitempty"`
// property names and values make up the configuration data which is to be provided to requiring modules at runtime
Properties map[string]interface{} `yaml:"properties,omitempty"`
Properties map[string]interface{} `yaml:"properties,omitempty" json:"properties,omitempty"`
// If a resource is declared to be active, it is allocated and bound according to declared requirements
Active *bool `yaml:"active,omitempty"`
Active *bool `yaml:"active,omitempty" json:"active,omitempty"`
// list of names either matching a resource name or a name provided by another module within the same MTA
Requires []Requires `yaml:"requires,omitempty" json:"requires,omitempty"`
}