Atlassian · Schema

ConnectModules

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
modules array A list of app modules in the same format as the `modules` property in the [app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).
View JSON Schema on GitHub

JSON Schema

atlassian-connectmodules-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectModules",
  "title": "ConnectModules",
  "example": {
    "jiraEntityProperties": [
      {
        "keyConfigurations": [
          {
            "extractions": [
              {
                "objectName": "extension",
                "type": "text",
                "alias": "attachmentExtension"
              }
            ],
            "propertyKey": "attachment"
          }
        ],
        "entityType": "issue",
        "name": {
          "value": "Attachment Index Document"
        },
        "key": "dynamic-attachment-entity-property"
      }
    ],
    "jiraIssueFields": [
      {
        "description": {
          "value": "A dynamically added single-select field"
        },
        "type": "single_select",
        "extractions": [
          {
            "path": "category",
            "type": "text",
            "name": "categoryName"
          }
        ],
        "name": {
          "value": "Dynamic single select"
        },
        "key": "dynamic-select-field"
      }
    ]
  },
  "properties": {
    "modules": {
      "description": "A list of app modules in the same format as the `modules` property in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).",
      "items": {
        "$ref": "#/components/schemas/ConnectModule"
      },
      "type": "array"
    }
  },
  "required": [
    "modules"
  ],
  "type": "object"
}