Class: Setting

Individual configuration settings.

 classDiagram
    class Setting
    click Setting href "../Setting/"
      Setting : description

      Setting : immutable

      Setting : name

      Setting : parameter

      Setting : schema





        Setting --> "1" Schema : schema
        click Schema href "../Schema/"

Attributes

Name	Cardinality and Range	Description	Inheritance
parameter	1 string	The name of the parameter the setting is associated ...	direct
name	1 string	The parameter's display name to show in the user interface	direct
description	0..1 string	The parameters's short description to provide additional context to the user ...	direct
immutable	0..1 boolean	If true, indicates the parameter value MUST not be changed once it has been s...	direct
schema	1 Schema	The name of the schema definition to use to validate the parameter's value	direct

Usages

used by	used in	type	used
Section	settings	range	Setting

---

This section is only relevant for contributors of the specification

LinkML Source

Direct

Details

name: Setting
description: Individual configuration settings.
from_schema: https://specification.margo.org/data-model
attributes:
  parameter:
    name: parameter
    description: The name of the [parameter](#parameter-attributes) the setting is
      associated with.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - Setting
    range: string
    required: true
  name:
    name: name
    description: The parameter's display name to show in the user interface.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - Component
    - Parameter
    - DeploymentMetadata
    - ApplicationMetadata
    - Author
    - Organization
    - Section
    - Setting
    - Schema
    - ComponentStatus
    range: string
    required: true
  description:
    name: description
    description: The parameters's short description to provide additional context
      to the user in the user interface about what the parameter is for.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - ApplicationMetadata
    - DeploymentProfileDescription
    - Setting
    range: string
  immutable:
    name: immutable
    description: If true, indicates the parameter value MUST not be changed once it
      has been set and used to install the application. Default is false if not provided.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - Setting
    range: boolean
  schema:
    name: schema
    description: The name of the schema definition to use to validate the parameter's
      value. See the [Schema](#schema-attributes) section below.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - Configuration
    - Setting
    range: Schema
    required: true
    inlined: false

Induced

Details

name: Setting
description: Individual configuration settings.
from_schema: https://specification.margo.org/data-model
attributes:
  parameter:
    name: parameter
    description: The name of the [parameter](#parameter-attributes) the setting is
      associated with.
    from_schema: https://specification.margo.org/application-schema
    alias: parameter
    owner: Setting
    domain_of:
    - Setting
    range: string
    required: true
  name:
    name: name
    description: The parameter's display name to show in the user interface.
    from_schema: https://specification.margo.org/application-schema
    alias: name
    owner: Setting
    domain_of:
    - Component
    - Parameter
    - DeploymentMetadata
    - ApplicationMetadata
    - Author
    - Organization
    - Section
    - Setting
    - Schema
    - ComponentStatus
    range: string
    required: true
  description:
    name: description
    description: The parameters's short description to provide additional context
      to the user in the user interface about what the parameter is for.
    from_schema: https://specification.margo.org/application-schema
    alias: description
    owner: Setting
    domain_of:
    - ApplicationMetadata
    - DeploymentProfileDescription
    - Setting
    range: string
  immutable:
    name: immutable
    description: If true, indicates the parameter value MUST not be changed once it
      has been set and used to install the application. Default is false if not provided.
    from_schema: https://specification.margo.org/application-schema
    alias: immutable
    owner: Setting
    domain_of:
    - Setting
    range: boolean
  schema:
    name: schema
    description: The name of the schema definition to use to validate the parameter's
      value. See the [Schema](#schema-attributes) section below.
    from_schema: https://specification.margo.org/application-schema
    alias: schema
    owner: Setting
    domain_of:
    - Configuration
    - Setting
    range: Schema
    required: true
    inlined: false