AARCHMRS Schema 2.5.3

↚ Home

Parameters.String object

String parameters are used to store a set of possible values.

object

Properties Type Description
_meta Meta
See Meta for more information.
_type
Enum
Parameters.String
allow_empty
  • boolean

When true, this parameter's domain can be empty.

Default
false
configured_by ParameterAbstract
See definitions.configured_by in ParameterAbstract for more information.
constraints ParameterAbstract
See definitions.constraints in ParameterAbstract for more information.
description ParameterAbstract
See definitions.description in ParameterAbstract for more information.
name ParameterAbstract
See definitions.name in ParameterAbstract for more information.
title ParameterAbstract
See definitions.title in ParameterAbstract for more information.
values
oneOf [
array
string
]

The current domain (possible values) of this Parameters.String.

oneOf array

oneOf string

Examples
"DEFINED_VALUE"
"ANOTHER DEFINED VALUE"
Additional Properties
Not Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "Parameters.String", 
    "name": "STRING_PARAM", 
    "values": [
        "SOME_VALUE", 
        "ANOTHER_VALUE"
    ]
}

Schema http://json-schema.org/draft-04/schema#

{
  "additionalProperties": false,
  "examples": [
    {
      "_type": "Parameters.String",
      "name": "STRING_PARAM",
      "values": [
        "SOME_VALUE",
        "ANOTHER_VALUE"
      ]
    }
  ],
  "info": [
    "String parameters are used to store a set of possible values."
  ],
  "properties": {
    "_meta": {
      "$ref": "../Meta.json"
    },
    "_type": {
      "enum": [
        "Parameters.String"
      ]
    },
    "name": {
      "$ref": "ParameterAbstract.json#/definitions/name"
    },
    "title": {
      "$ref": "ParameterAbstract.json#/definitions/title"
    },
    "description": {
      "$ref": "ParameterAbstract.json#/definitions/description"
    },
    "constraints": {
      "$ref": "ParameterAbstract.json#/definitions/constraints"
    },
    "configured_by": {
      "$ref": "ParameterAbstract.json#/definitions/configured_by"
    },
    "values": {
      "info": [
        "The current domain (possible values) of this $(Parameters.String)."
      ],
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "type": "string"
        }
      ],
      "examples": [
        "DEFINED_VALUE",
        "ANOTHER DEFINED VALUE"
      ]
    },
    "allow_empty": {
      "info": [
        "When `true`, this parameter's domain can be empty."
      ],
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "name",
    "values"
  ],
  "title": "Parameters.String",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object"
}