Atlassian · Schema

HistoryMetadata

Details of issue history metadata.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
activityDescription	string	The activity described in the history record.
activityDescriptionKey	string	The key of the activity described in the history record.
actor	object	Details of the user whose action created the history record.
cause	object	Details of the cause that triggered the creation the history record.
description	string	The description of the history record.
descriptionKey	string	The description key of the history record.
emailDescription	string	The description of the email address associated the history record.
emailDescriptionKey	string	The description key of the email address associated the history record.
extraData	object	Additional arbitrary information about the history record.
generator	object	Details of the system that generated the history record.
type	string	The type of the history record.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HistoryMetadata",
  "title": "HistoryMetadata",
  "additionalProperties": true,
  "description": "Details of issue history metadata.",
  "properties": {
    "activityDescription": {
      "description": "The activity described in the history record.",
      "type": "string"
    },
    "activityDescriptionKey": {
      "description": "The key of the activity described in the history record.",
      "type": "string"
    },
    "actor": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ],
      "description": "Details of the user whose action created the history record."
    },
    "cause": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ],
      "description": "Details of the cause that triggered the creation the history record."
    },
    "description": {
      "description": "The description of the history record.",
      "type": "string"
    },
    "descriptionKey": {
      "description": "The description key of the history record.",
      "type": "string"
    },
    "emailDescription": {
      "description": "The description of the email address associated the history record.",
      "type": "string"
    },
    "emailDescriptionKey": {
      "description": "The description key of the email address associated the history record.",
      "type": "string"
    },
    "extraData": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Additional arbitrary information about the history record.",
      "type": "object"
    },
    "generator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ],
      "description": "Details of the system that generated the history record."
    },
    "type": {
      "description": "The type of the history record.",
      "type": "string"
    }
  },
  "type": "object"
}