AARCHMRS Schema 2.7.4

↚ Home

Traits.HasDescription object

HasDescription provides additional schema elements for descriptions. HasDescription should not be used on its own but instead used as a reference schema for classes that have descriptions.

definition

Definitions Type Description
description Description

Provides an architectural description of this field.

You can use a dictionary that contains before and after keys, where:

  • The before key is used to define architectural information before the values are represented.
  • The after key is used to define architectural description after the values are represented.

If the property value is of type string, this behaves as having a description with just the before key, before and after have no architectural significance, this is just for rendering.

See Description for more information.
Examples
{
    "_type": "Description", 
    "after": [
        "This is a description that appears after Values."
    ], 
    "before": [
        "This is a description that appears before Values"
    ]
}

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

{
  "info": [
    "HasDescription provides additional schema elements for descriptions. HasDescription should not be used on its own but instead used as a reference schema for classes that have descriptions."
  ],
  "additionalProperties": false,
  "definitions": {
    "description": {
      "$ref": "../Description.json",
      "examples": [
        {
          "_type": "Description",
          "after": [
            "This is a description that appears after Values."
          ],
          "before": [
            "This is a description that appears before Values"
          ]
        }
      ],
      "info": [
        "Provides an architectural description of this field.",
        "You can use a dictionary that contains `before` and `after` keys, where:",
        [
          " - The `before` key is used to define architectural information before the values are represented.",
          " - The `after` key is used to define architectural description after the values are represented."
        ],
        [
          "If the property value is of type `string`, this behaves as having a description with just the _before_ key, ",
          "`before` and `after` have no architectural significance, this is just for rendering."
        ]
      ]
    }
  },
  "title": "Traits.HasDescription",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object"
}